annotate amrfinderplus.xml @ 10:e533cf6725bf tip

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