Mercurial > repos > card > rgi

annotate rgi.xml @ 2:a671367c326e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/arpcard/rgi commit 481838067117d0c8ae84bc92ee58f47cfc18aa5f"
author card
date Tue, 17 Nov 2020 00:23:36 +0000
parents f96cbb663aa9
children ce852ee2c394
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
a671367c326e "planemo upload for repository https://github.com/arpcard/rgi commit 481838067117d0c8ae84bc92ee58f47cfc18aa5f"
card
parents: 1
diff changeset
1 <tool id="rgi" name="Resistance Gene Identifier (RGI)" version="5.1.1">
0
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
2 <description>This tool predicts resistome(s) from protein or nucleotide data based on homology and SNP models.</description>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
3 <requirements>
2
a671367c326e "planemo upload for repository https://github.com/arpcard/rgi commit 481838067117d0c8ae84bc92ee58f47cfc18aa5f"
card
parents: 1
diff changeset
4 <requirement type="package" version="5.1.1">rgi</requirement>
0
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
5 </requirements>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
6 <stdio>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
7 <exit_code range="1:" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
8 </stdio>
1
f96cbb663aa9 planemo upload for repository https://github.com/arpcard/rgi commit 09a75bd2d655c05892acf7585a7ed08548f1c86d
card
parents: 0
diff changeset
9 <command detect_errors="aggressive"><![CDATA[
0
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
10 #if $db_opts.db_opts_selector != "default":
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
11 rgi load
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
12 #if $db_opts.db_opts_selector == "local":
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
13 -i "${__tool_data_path__}/rgi_databases/$db_opts.rgi_db_local/card.json"
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
14 #else:
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
15 -i "$db_opts.rgi_db_hist"
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
16 #end if
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
17 --local
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
18 &&
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
19 #end if
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
20
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
21 rgi main
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
22 -i '$input_sequence'
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
23 -o out
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
24 -t $input_type
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
25 -a $alignment_tool
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
26 -n "\${GALAXY_SLOTS:-1}"
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
27 $include_loose
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
28 $low_quality
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
29 -d $data
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
30
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
31 #if $db_opts.db_opts_selector != "default":
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
32 --local
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
33 #end if
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
34 ]]></command>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
35 <inputs>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
36 <param argument="--input_sequence" type="data" format="fastq,fasta" label="Input sequence" help="input file must be in either FASTA (contig and protein) or gzip format e.g myFile.fasta, myFasta.fasta.gz"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
37 <param argument="--input_type" type="select" multiple="false" label="Input type" help="specify data input type (default = contig)">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
38 <option value="contig" selected="true">CONTIG (Nucleotide Sequence)</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
39 <option value="protein">PROTEIN (Protein Sequence)</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
40 </param>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
41 <param argument="--alignment_tool" type="select" label="Alignment tool" help="specify alignment tool (default = BLAST)">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
42 <option value="blast" selected="true">BLAST</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
43 <option value="diamond">DIAMOND</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
44 </param>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
45 <param argument="--include_loose" type="boolean" checked="false" truevalue="--include_loose" falsevalue="" label="Include loose hits" help="include loose hits in addition to strict and perfect hits"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
46 <param argument="--low_quality" type="boolean" checked="false" truevalue="--low_quality" falsevalue="" label="Low quality" help="use for short contigs to predict partial genes"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
47 <param argument="--data" type="select" multiple="false" label="Data type" help="specify a data-type (default = NA)">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
48 <option value="wgs">WGS</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
49 <option value="plasmid">PLASMID</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
50 <option value="chromosome">CHROMOSOME</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
51 <option value="NA" selected="true">NA</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
52 </param>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
53 <conditional name="db_opts">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
54 <param name="db_opts_selector" type="select" label="Select an RGI database">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
55 <option value="default" selected="true">Default RGI database</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
56 <option value="local">Locally installed RGI database</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
57 <option value="hist">RGI database from your history</option>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
58 </param>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
59 <when value="default">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
60 <param name="rgi_db_local" type="hidden" value="" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
61 <param name="rgi_db_hist" type="hidden" value="" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
62 </when>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
63 <when value="local">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
64 <param name="rgi_db_local" type="select" multiple="false" label="Locally installed RGI database">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
65 <options from_data_table="rgi_databases">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
66 <validator type="no_options" message="No databases are available built-in"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
67 </options>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
68 </param>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
69 <param name="rgi_db_hist" type="hidden" value="" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
70 </when>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
71 <when value="hist">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
72 <param name="rgi_db_local" type="hidden" value="" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
73 <param name="rgi_db_hist" type="data" format="json" label="RGI database from your history" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
74 </when>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
75 </conditional>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
76 </inputs>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
77 <outputs>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
78 <data name="report" format="json" from_work_dir="out.json" label="${tool.name} on ${on_string}: report.json"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
79 <data name="summary" format="tabular" from_work_dir="out.txt" label="${tool.name} on ${on_string}: summary.txt"/>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
80 </outputs>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
81 <tests>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
82 <test>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
83 <param name="input_sequence" value="test1.fasta" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
84 <param name="input_type" value="contig" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
85 <param name="alignment_tool" value="blast" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
86 <param name="include_loose" value="false" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
87 <param name="low_quality" value="false" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
88 <param name="data" value="NA" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
89 <conditional name="db_opts">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
90 <param name="db_opts_selector" value="default" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
91 </conditional>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
92 <output name="summary">
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
93 <assert_contents>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
94 <has_text text="AY123251" />
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
95 </assert_contents>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
96 </output>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
97 </test>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
98 </tests>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
99 <help>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
100 <![CDATA[
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
101 Resistance Gene Identifier (RGI)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
102 ================================
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
103
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
104 RGI is used to predict resistome(s) from protein or nucleotide data based on homology and SNP models. The tool uses data from the CARD database.
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
105
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
106 Usage
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
107 -----
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
108
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
109 1. Select your input sequence (in FASTA format).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
110 2. Select your input type (CONTIG or PROTEIN).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
111 3. Select your alignment tool (DIAMOND or BLAST).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
112 4. Specify if you want to include loose hits (YES or NO).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
113 5. Specify if you want to remove temporary files (YES or NO).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
114 6. Specify if you want to low quality predictions (YES or NO).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
115 7. Select your data type (WGS, PLASMID, CHROMOSOME or NA).
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
116 8. Run the tool.
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
117
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
118 Output
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
119 ------
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
120
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
121 There are 2 different output files produced by `rgi`.
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
122
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
123 summary.txt
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
124 ^^^^^^^^^^^
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
125
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
126 A tabular file of all detected resistance genes, one gene per line.
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
127
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
128 +--------------------------------------------------------------------------------------------------------------------------+---------------+-------+------+-------------+----------+----------------+---------------------+----------------+------------------+----------+-----------------------+--------------------------+-------------+------------+-------------------------+----------------------+---------------------------+------------------------+---------------------------+-----------------------------------------+--------------------------------+-----------+
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
129 | ORF_ID | Contig | Start | Stop | Orientation | Cut_Off | Pass_Bitscore | Best_Hit_Bitscore | Best_Hit_ARO | Best_Identities | ARO | Model_type | SNPs_in_Best_Hit_ARO | Other_SNPs | Drug Class | Resistance Mechanism | AMR Gene Family | Predicted_DNA | Predicted_Protein | CARD_Protein_Sequence | Percentage Length of Reference Sequence | ID | Model_ID |
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
130 +==========================================================================================================================+===============+=======+======+=============+==========+================+=====================+================+==================+==========+=======================+==========================+=============+============+=========================+======================+===========================+========================+===========================+=========================================+================================+===========+
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
131 | AY123251.1_6 # 3575 # 4489 # 1 # ID=1_6;partial=00;start_type=ATG;rbs_motif=None;rbs_spacer=None;gc_cont=0.399 | AY123251.1_6 | 3575 | 4489 | \+ | Strict | 500 | 506.908 | CARB-7 | 83.68 | 3002246 | protein homolog model | n/a | n/a | penam | antibiotic inactivation | CARB beta-lactamase | ATGC | MLLYKMCDNQNYGVTYMKFLLV | MKSLLVFALLMPSVVFASSSKFQSV | 105.56 | gnl|BL_ORD_ID|589|hsp_num:0 | 1443 |
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
132 +--------------------------------------------------------------------------------------------------------------------------+---------------+-------+------+-------------+----------+----------------+---------------------+----------------+------------------+----------+-----------------------+--------------------------+-------------+------------+-------------------------+----------------------+---------------------------+------------------------+---------------------------+-----------------------------------------+--------------------------------+-----------+
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
133
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
134 report.json
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
135 ^^^^^^^^^^^
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
136
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
137 A json version of summary.txt.
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
138
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
139 Help
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
140 ----
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
141
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
142 **usage:**
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
143 ``rgi main [-h] -i INPUT_SEQUENCE -o OUTPUT_FILE [-t {read,contig,protein,wgs}] [-a {DIAMOND,BLAST}] [-n THREADS] [--include_loose] [--local] [--clean] [--debug] [--low_quality] [-d {wgs,plasmid,chromosome,NA}] [-v]``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
144
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
145 **optional arguments:**
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
146
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
147 - ``-h, --help``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
148 show this help message and exit
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
149 - ``-i INPUT_SEQUENCE, --input_sequence INPUT_SEQUENCE``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
150 input file must be in either FASTA (contig and protein) or gzip format e.g myFile.fasta, myFasta.fasta.gz
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
151 - ``-o OUTPUT_FILE, --output_file OUTPUT_FILE``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
152 output folder and base filename
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
153 - ``-t {read,contig,protein,wgs}, --input_type {read,contig,protein,wgs}``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
154 specify data input type (default = contig)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
155 - ``-a {DIAMOND,BLAST}, --alignment_tool {DIAMOND,BLAST}``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
156 specify alignment tool (default = BLAST)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
157 - ``-n THREADS, --num_threads THREADS``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
158 number of threads (CPUs) to use in the BLAST search (default=8)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
159 - ``--include_loose``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
160 include loose hits in addition to strict and perfect hits
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
161 - ``--local``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
162 use local database (default: uses database in executable directory)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
163 - ``--clean``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
164 removes temporary files
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
165 - ``--debug``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
166 debug mode
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
167 - ``--low_quality``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
168 use for short contigs to predict partial genes
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
169 - ``-d {wgs,plasmid,chromosome,NA}, --data {wgs,plasmid,chromosome,NA}``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
170 specify a data-type (default = NA)
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
171 - ``-v, --version``
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
172 prints software version number
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
173
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
174 Links
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
175 -----
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
176
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
177 RGI: https://card.mcmaster.ca/analyze/rgi
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
178
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
179 Github: https://github.com/arpcard/rgi
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
180
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
181 CARD database: https://card.mcmaster.ca
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
182 ]]>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
183 </help>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
184 <citations>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
185 <citation type="doi">10.1093/nar/gkw1004</citation>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
186 </citations>
715bc9aeef69 planemo upload for repository https://github.com/arpcard/rgi commit 7a78289be23c5a14ae39f454610fa8eca3f05188
card
parents:
diff changeset
187 </tool>