Mercurial > repos > devteam > kraken
annotate kraken.xml @ 2:898ded2d4fff draft
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
| author | devteam |
|---|---|
| date | Wed, 15 Jul 2015 14:59:31 -0400 |
| parents | 656215d2a793 |
| children | 2ad66362ed0f |
| rev | line source |
|---|---|
| 0 | 1 <?xml version="1.0"?> |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
2 <tool id="kraken" name="Kraken" version="1.1.0"> |
| 0 | 3 <description> |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
4 assign taxonomic labels to sequencing reads |
| 0 | 5 </description> |
| 6 <macros> | |
| 7 <import>macros.xml</import> | |
| 8 </macros> | |
| 9 <command> | |
| 10 <![CDATA[ | |
|
1
656215d2a793
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb1743eafd4ca98be0148d557770ef8635cc8d4c-dirty
devteam
parents:
0
diff
changeset
|
11 @SET_DATABASE_PATH@ && |
| 0 | 12 kraken --threads \${GALAXY_SLOTS:-1} @INPUT_DATABASE@ |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
13 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
14 #if $input_sequences.is_of_type( 'fastq' ): |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
15 --fastq-input |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
16 #else: |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
17 --fasta-input |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
18 #end if |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
19 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
20 ${only_classified_output} |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
21 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
22 #if str( $quick_operation.quick ) == "yes": |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
23 --quick |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
24 --min-hits ${quick_operation.min_hits} |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
25 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
26 #end if |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
27 |
| 0 | 28 "$input_sequences" |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
29 |
| 0 | 30 #if $split_reads: |
| 31 --classified-out "${classified_out}" --unclassified-out "${unclassified_out}" | |
| 32 #end if | |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
33 --output "${output}" |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
34 ##kraken-translate --db ${kraken_database.fields.name} "${output}" > "${translated}" |
| 0 | 35 ]]> |
| 36 </command> | |
| 37 <inputs> | |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
38 <param format="fasta,fastq" label="Input sequences" name="input_sequences" type="data" help="FASTA or FASTQ datasets"/> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
39 <param label="Output classified and unclassified reads?" name="split_reads" type="boolean" help="Sets --unclassified-out and --classified-out"/> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
40 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
41 <conditional name="quick_operation"> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
42 <param name="quick" type="select" label="Enable quick operation?" help="--quick; Rather than searching all k-mers in a sequence, stop classification after a specified number of database hit"> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
43 <option value="yes">Yes</option> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
44 <option selected="True" value="no">No</option> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
45 </param> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
46 <when value="yes"> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
47 <param name="min_hits" type="integer" value="1" label="Number of hits required for classification" help="--min-hits; min-hits will allow you to require multiple hits before declaring a sequence classified, which can be especially useful with custom databases when testing to see if sequences either do or do not belong to a particular genome; default=1"/> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
48 </when> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
49 <when value="no"> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
50 <!-- Do absolutely nothing --> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
51 </when> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
52 </conditional> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
53 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
54 <param name="only_classified_output" type="boolean" checked="False" truevalue="--only-classified-output" falsevalue="" label="Print no Kraken output for unclassified sequences" help="--only-classified-output"/> |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
55 |
| 0 | 56 <expand macro="input_database" /> |
| 57 </inputs> | |
| 58 <outputs> | |
| 59 <data format="tabular" label="${tool.name} on ${on_string}: Classified reads" name="classified_out"> | |
| 60 <filter>(split_reads)</filter> | |
| 61 </data> | |
| 62 <data format="tabular" label="${tool.name} on ${on_string}: Unclassified reads" name="unclassified_out"> | |
| 63 <filter>(split_reads)</filter> | |
| 64 </data> | |
| 65 <data format="tabular" label="${tool.name} on ${on_string}: Classification" name="output" /> | |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
66 <!--<data format="tabular" label="${tool.name} on ${on_string}: Translated classification" name="translated" />--> |
| 0 | 67 </outputs> |
| 68 <help> | |
| 69 <![CDATA[ | |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
70 **What it does** |
| 0 | 71 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
72 Kraken is a taxonomic sequence classifier that assigns taxonomic labels to short DNA reads. It does this by examining the k-mers within a read and querying a database with those k-mers. This database contains a mapping of every k-mer in Kraken's genomic library to the lowest common ancestor (LCA) in a taxonomic tree of all genomes that contain that k-mer. The set of LCA taxa that correspond to the k-mers in a read are then analyzed to create a single taxonomic label for the read; this label can be any of the nodes in the taxonomic tree. Kraken is designed to be rapid, sensitive, and highly precise. |
| 0 | 73 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
74 ----- |
| 0 | 75 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
76 **Kraken options** |
| 0 | 77 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
78 The Galaxy version of Kraken implements the following options:: |
| 0 | 79 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
80 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
81 --fasta-input Input is FASTA format |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
82 --fastq-input Input is FASTQ format |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
83 --quick Quick operation (use first hit or hits) |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
84 --min-hits NUM In quick op., number of hits req'd for classification |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
85 NOTE: this is ignored if --quick is not specified |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
86 --unclassified-out Print unclassified sequences to filename |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
87 --classified-out Print classified sequences to filename |
| 0 | 88 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
89 --only-classified-output Print no Kraken output for unclassified sequences |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
90 |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
91 ------ |
| 0 | 92 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
93 **Output Format** |
| 0 | 94 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
95 Each sequence classified by Kraken results in a single line of output. Output lines contain five tab-delimited fields; from left to right, they are:: |
| 0 | 96 |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
97 1. "C"/"U": one letter code indicating that the sequence was either classified or unclassified. |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
98 2. The sequence ID, obtained from the FASTA/FASTQ header. |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
99 3. The taxonomy ID Kraken used to label the sequence; this is 0 if the sequence is unclassified. |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
100 4. The length of the sequence in bp. |
|
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
101 5. A space-delimited list indicating the LCA mapping of each k-mer in the sequence. For example, "562:13 561:4 A:31 0:1 562:3" would indicate that: |
| 0 | 102 a) the first 13 k-mers mapped to taxonomy ID #562 |
| 103 b) the next 4 k-mers mapped to taxonomy ID #561 | |
| 104 c) the next 31 k-mers contained an ambiguous nucleotide | |
| 105 d) the next k-mer was not in the database | |
| 106 e) the last 3 k-mers mapped to taxonomy ID #562 | |
| 107 ]]> | |
| 108 </help> | |
| 109 <expand macro="requirements" /> | |
| 110 <expand macro="stdio" /> | |
| 111 <expand macro="version_command" /> | |
| 112 <expand macro="citations" /> | |
|
2
898ded2d4fff
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents:
1
diff
changeset
|
113 </tool> |
