annotate amrfinder.xml @ 9:5dab9e814c5e tip

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