annotate amrfinderplus/amrfinderplus.xml @ 10:e533cf6725bf tip

Uploaded
author estrain
date Thu, 25 Jun 2020 16:21:48 -0400
parents b2a378cdaafa
children
rev   line source
estrain@10 1 <tool id="amrfinderGT" name="amrfinder-plusGT" version="@VERSION@+galaxy1">
estrain@4 2 <description>
estrain@4 3 identifies AMR genes using either protein annotations or nucleotide sequence.
estrain@4 4 </description>
estrain@4 5 <macros>
estrain@7 6 <token name="@VERSION@">3.8.4</token>
estrain@4 7 </macros>
estrain@4 8 <requirements>
estrain@4 9 <requirement type="package" version="@VERSION@">ncbi-amrfinderplus</requirement>
estrain@4 10 </requirements>
estrain@4 11 <version_command><![CDATA[amrfinder --version]]></version_command>
estrain@4 12
estrain@4 13 <command detect_errors="exit_code"><![CDATA[
estrain@4 14 amrfinder
estrain@4 15 $plus
estrain@4 16 --threads \${GALAXY_SLOTS:-1}
estrain@4 17 --database '$amrfinder_databases.fields.path'
estrain@4 18 #if $input_selection.input_source_selector == 'nuc'
estrain@4 19 -n '$input_selection.fasta_file'
estrain@4 20 #elif $input_selection.input_source_selector == 'pro'
estrain@4 21 -p '$input_selection.fasta_file'
estrain@4 22 #if $input_selection.gff.use == 'gff_yes'
estrain@4 23 -g '$input_selection.gff.gff_file'
estrain@4 24 #end if
estrain@4 25 #elif $input_selection.input_source_selector == 'both'
estrain@4 26 -n '$input_selection.nuc_file'
estrain@4 27 -p '$input_selection.pro_file'
estrain@4 28 #if $input_selection.gff.use == 'gff_yes'
estrain@4 29 -g '$input_selection.gff.gff_file'
estrain@4 30 #end if
estrain@4 31 #end if
estrain@4 32 #if str($organism) != 'None'
estrain@4 33 -O $organism
estrain@4 34 #end if
estrain@4 35 -o results.tsv
estrain@4 36 $report_common
estrain@4 37 #if $point_mut_all
estrain@4 38 --point_mut_all point_mutate.tsv
estrain@4 39 #end if
estrain@4 40 $gpipe
estrain@4 41 ]]> </command>
estrain@4 42
estrain@4 43 <inputs>
estrain@4 44 <conditional name="input_selection">
estrain@4 45 <param name="input_source_selector" type="select" label="Input data type">
estrain@4 46 <option value="nuc">Nucleotide</option>
estrain@4 47 <option value="pro">Protein</option>
estrain@4 48 <option value="both">Nucleotide and Protein</option>
estrain@4 49 </param>
estrain@4 50 <when value="nuc">
estrain@4 51 <param name="fasta_file" type="data" format="fasta" label="Select nucleotide fasta file"/>
estrain@4 52 </when>
estrain@4 53 <when value="pro">
estrain@4 54 <param name="fasta_file" type="data" format="fasta" label="Select protein fasta file"/>
estrain@4 55 <conditional name="gff">
estrain@4 56 <param name="use" type="select" label="Using GFF to get genomic coordinates">
estrain@4 57 <option value="gff_yes">Yes</option>
estrain@4 58 <option value="gff_no" selected="true">No</option>
estrain@4 59 </param>
estrain@4 60 <when value="gff_yes">
estrain@4 61 <param name="gff_file" type="data" format="gff,gff3" label="Select GFF file" help="Protein id should be in the attribute 'Name=id' (9th field) of the rows with type 'CDS' or 'gene' (3rd field)."/>
estrain@4 62 </when>
estrain@4 63 <when value="gff_no">
estrain@4 64 </when>
estrain@4 65 </conditional>
estrain@4 66 </when>
estrain@4 67 <when value="both">
estrain@4 68 <param name="nuc_file" type="data" format="fasta" label="Select a nucleotide fasta file"/>
estrain@4 69 <param name="pro_file" type="data" format="fasta" label="Select a protein fasta file"/>
estrain@4 70 <conditional name="gff">
estrain@4 71 <param name="use" type="select" label="Using GFF to get genomic coordinates">
estrain@4 72 <option value="gff_yes">Yes</option>
estrain@4 73 <option value="gff_no" selected="true">No</option>
estrain@4 74 </param>
estrain@4 75 <when value="gff_yes">
estrain@4 76 <param name="gff_file" type="data" format="gff,gff3" label="Select GFF file" help="Protein id should be in the attribute 'Name=id' (9th field) of the rows with type 'CDS' or 'gene' (3rd field)."/>
estrain@4 77 </when>
estrain@4 78 <when value="gff_no">
estrain@4 79 </when>
estrain@4 80 </conditional>
estrain@4 81 </when>
estrain@4 82 </conditional>
estrain@4 83 <!-- DATABASE INPUT-->
estrain@4 84 <param name="amrfinder_databases" label="Select a database" type="select">
estrain@4 85 <options from_data_table="amrfinder_databases">
estrain@4 86 <validator message="No database is available" type="no_options" />
estrain@4 87 </options>
estrain@4 88 </param>
estrain@4 89 <param name="organism" type="select" optional="true" label="Get organism-specific results">
estrain@4 90 <option value="Campylobacter">Campylobacter</option>
estrain@4 91 <option value="Escherichia">Escherichia</option>
estrain@4 92 <option value="Klebsiella">Klebsiella</option>
estrain@4 93 <option value="Salmonella">Salmonella</option>
estrain@4 94 <option value="Staphylococcus">Staphylococcus</option>
estrain@4 95 <option value="Vibrio">Vibrio</option>
estrain@4 96 </param>
estrain@4 97 <param name="min_iden" argument="--ident_min" type="float" value="-1" label="Minimum identity for a blast-based hit" help="(Methods BLAST or PARTIAL). -1 means use a curated threshold if it exists and 0.9 otherwise. Setting this value to something other than -1 will override any curated similarity cutoffs" />
estrain@4 98 <param name="min_cov" argument="--coverage_min" type="float" min="0" max="1" value="0.5" label="Minimum coverage of the reference protein" />
estrain@4 99 <param name="plus" type="boolean" truevalue="--plus" falsevalue="" label="Add the plus genes to the report" />
estrain@4 100 <param name="report_common" type="boolean" truevalue="--report_common" falsevalue="" label="Suppress proteins common to a taxonomy group" />
estrain@4 101 <param name="point_mut_all" type="boolean" truevalue="true" falsevalue="false" label="Report all target positions of reference point mutations" />
estrain@4 102 <param name="gpipe" type="boolean" truevalue="--gpipe" falsevalue="" label="Protein identifiers in the protein FASTA file have format gnl-project-accession" />
estrain@4 103 </inputs>
estrain@4 104
estrain@4 105 <outputs>
estrain@4 106 <data name="result" format="tabular" from_work_dir="results.tsv" label="${tool.name} on ${on_string}: Result"/>
estrain@4 107 <data name="point_mutate" format="tabular" from_work_dir="point_mutate.tsv" label="${tool.name} on ${on_string}: Point mutate all">
estrain@4 108 <filter>point_mut_all</filter>
estrain@4 109 </data>
estrain@4 110 </outputs>
estrain@4 111
estrain@4 112 <tests>
estrain@4 113 <test> <!-- dna input-->
estrain@4 114 <param name="input_source_selector" value="nuc"/>
estrain@4 115 <param name="fasta_file" value="test_dna.fa" ftype="fasta"/>
estrain@4 116 <param name="amrfinder_databases" value="2019-08-27.1" />
estrain@4 117 <output name="result" file="test_dna.expected" lines_diff="1"/>
estrain@4 118 </test>
estrain@4 119 <test> <!-- dna input and organism, plus gene-->
estrain@4 120 <param name="input_source_selector" value="nuc"/>
estrain@4 121 <param name="fasta_file" value="test_dna.fa" ftype="fasta"/>
estrain@4 122 <param name="organism" value="Escherichia" />
estrain@4 123 <param name="plus" value="true" />
estrain@4 124 <param name="amrfinder_databases" value="2019-08-27.1" />
estrain@4 125 <output name="result" file="test_dna_Escherichia.expected" lines_diff="1"/>
estrain@4 126 </test>
estrain@4 127 <test> <!-- AA input-->
estrain@4 128 <param name="input_source_selector" value="pro"/>
estrain@4 129 <param name="fasta_file" value="test_prot.fa" ftype="fasta"/>
estrain@4 130 <param name="amrfinder_databases" value="2019-08-27.1" />
estrain@4 131 <output name="result" file="test_prot.expected" lines_diff="1"/>
estrain@4 132 </test>
estrain@4 133 <test> <!-- DNA and AA input-->
estrain@4 134 <param name="input_source_selector" value="both"/>
estrain@4 135 <param name="use" value="gff_yes"/>
estrain@4 136 <param name="nuc_file" value="test_dna.fa" ftype="fasta"/>
estrain@4 137 <param name="pro_file" value="test_prot.fa" ftype="fasta"/>
estrain@4 138 <param name="use" value="gff_yes"/>
estrain@4 139 <param name="gff_file" value="test_prot.gff" ftype="gff3"/>
estrain@4 140 <param name="amrfinder_databases" value="2019-08-27.1" />
estrain@4 141 <output name="result" file="test_both.expected" lines_diff="1"/>
estrain@4 142 </test>
estrain@4 143 </tests>
estrain@4 144
estrain@4 145
estrain@4 146 <help><![CDATA[
estrain@4 147 This software and the accompanying database are designed to find acquired
estrain@4 148 antimicrobial resistance genes in bacterial protein or assembled nucleotide
estrain@4 149 sequences as well as known point mutations for several taxa. With
estrain@4 150 AMRFinderPlus we have added select members of additional classes of genes
estrain@4 151 such as virulence factors, biocide, heat, acid, and metal resistance genes.
estrain@4 152 More details: https://github.com/ncbi/amr/wiki
estrain@4 153 ]]> </help>
estrain@4 154 <citations>
estrain@4 155 <citation type="doi">10.1101/550707</citation>
estrain@4 156 </citations>
estrain@4 157
estrain@4 158 </tool>