annotate kraken.xml @ 14:fd27c97c8366 draft default tip

Uploaded
author cschu
date Mon, 18 May 2015 15:55:47 -0400
parents df4163858937
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
df4163858937 Uploaded
cschu
parents:
diff changeset
1 <tool id="kraken" name="kraken">
df4163858937 Uploaded
cschu
parents:
diff changeset
2 <description>taxonomic sequence classifier</description>
df4163858937 Uploaded
cschu
parents:
diff changeset
3 <requirements>
df4163858937 Uploaded
cschu
parents:
diff changeset
4 <requirement type="package" version="2.7">python</requirement>
df4163858937 Uploaded
cschu
parents:
diff changeset
5 <requirement type="package" version="0.10.5">kraken</requirement>
df4163858937 Uploaded
cschu
parents:
diff changeset
6 </requirements>
df4163858937 Uploaded
cschu
parents:
diff changeset
7 <command interpreter="python">kraken.py
df4163858937 Uploaded
cschu
parents:
diff changeset
8 --dbtype="${databaseChoice.database}"
df4163858937 Uploaded
cschu
parents:
diff changeset
9 #if $databaseChoice.database == "builtinDB":
df4163858937 Uploaded
cschu
parents:
diff changeset
10 --db="${databaseChoice.builtinDatabases.fields.path}"
df4163858937 Uploaded
cschu
parents:
diff changeset
11 #else:
df4163858937 Uploaded
cschu
parents:
diff changeset
12 --db="NOT_SUPPORTED_YET"
df4163858937 Uploaded
cschu
parents:
diff changeset
13 #end if
df4163858937 Uploaded
cschu
parents:
diff changeset
14
df4163858937 Uploaded
cschu
parents:
diff changeset
15 --in1="${dataFormat.input1}"
df4163858937 Uploaded
cschu
parents:
diff changeset
16 #if $dataFormat.inputFormat == "pairedFastQ" or $dataFormat.inputFormat == "pairedFastA":
df4163858937 Uploaded
cschu
parents:
diff changeset
17 --in2="${dataFormat.input2}"
df4163858937 Uploaded
cschu
parents:
diff changeset
18 #end if
df4163858937 Uploaded
cschu
parents:
diff changeset
19
df4163858937 Uploaded
cschu
parents:
diff changeset
20 #if $dataFormat.inputFormat == "singleFastQ" or $dataFormat.inputFormat == "pairedFastQ":
df4163858937 Uploaded
cschu
parents:
diff changeset
21 --input-format="fq"
df4163858937 Uploaded
cschu
parents:
diff changeset
22 #else:
df4163858937 Uploaded
cschu
parents:
diff changeset
23 --input-format="fa"
df4163858937 Uploaded
cschu
parents:
diff changeset
24 #end if
df4163858937 Uploaded
cschu
parents:
diff changeset
25
df4163858937 Uploaded
cschu
parents:
diff changeset
26 #if $quickMode.useQuickMode == "useQuick":
df4163858937 Uploaded
cschu
parents:
diff changeset
27 --quick
df4163858937 Uploaded
cschu
parents:
diff changeset
28 --min-hits="${quickMode.minHits.value}"
df4163858937 Uploaded
cschu
parents:
diff changeset
29 #end if
df4163858937 Uploaded
cschu
parents:
diff changeset
30
df4163858937 Uploaded
cschu
parents:
diff changeset
31 <!-- $output -->
df4163858937 Uploaded
cschu
parents:
diff changeset
32 $kraken_summary_tsv
df4163858937 Uploaded
cschu
parents:
diff changeset
33 <!-- $classified_seqs_fq
df4163858937 Uploaded
cschu
parents:
diff changeset
34 $unclassified_seqs_fq -->
df4163858937 Uploaded
cschu
parents:
diff changeset
35 </command>
df4163858937 Uploaded
cschu
parents:
diff changeset
36 <inputs>
df4163858937 Uploaded
cschu
parents:
diff changeset
37 <conditional name="databaseChoice">
df4163858937 Uploaded
cschu
parents:
diff changeset
38 <param name="database" type="select" label="Do you want to use your own kraken database or use the built-in ktest database?">
df4163858937 Uploaded
cschu
parents:
diff changeset
39 <option value="builtinDB">Use built-in db</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
40 <option value="myownDB">Use a db from my history</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
41 </param>
df4163858937 Uploaded
cschu
parents:
diff changeset
42 <when value="builtinDB">
df4163858937 Uploaded
cschu
parents:
diff changeset
43 <param name="builtinDatabases" type="select" label="Select a built-in kraken database">
df4163858937 Uploaded
cschu
parents:
diff changeset
44 <options from_data_table="krakenDBs">
df4163858937 Uploaded
cschu
parents:
diff changeset
45 <filter type="sort_by" column="2" />
df4163858937 Uploaded
cschu
parents:
diff changeset
46 <validator type="no_options" message="No databases are available" />
df4163858937 Uploaded
cschu
parents:
diff changeset
47 </options>
df4163858937 Uploaded
cschu
parents:
diff changeset
48 </param>
df4163858937 Uploaded
cschu
parents:
diff changeset
49 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
50 <when value="myownDB">
df4163858937 Uploaded
cschu
parents:
diff changeset
51 <param name="myownDB" type="data" format="fasta" metadata_name="dbkey" label="Select database" />
df4163858937 Uploaded
cschu
parents:
diff changeset
52 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
53 </conditional>
df4163858937 Uploaded
cschu
parents:
diff changeset
54
df4163858937 Uploaded
cschu
parents:
diff changeset
55 <conditional name="quickMode">
df4163858937 Uploaded
cschu
parents:
diff changeset
56 <param name="useQuickMode" type="select" label="Use Quick operation? (use first hit or hits)">
df4163858937 Uploaded
cschu
parents:
diff changeset
57 <option value="useQuick">Use Quick operation</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
58 <option value="dontUseQuick">Do not use Quick operation</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
59 </param>
df4163858937 Uploaded
cschu
parents:
diff changeset
60 <when value="useQuick">
df4163858937 Uploaded
cschu
parents:
diff changeset
61 <param name="minHits" type="integer" label="Minimum number of hits required for classification (default:1)" value="1" default="1" />
df4163858937 Uploaded
cschu
parents:
diff changeset
62 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
63 </conditional>
df4163858937 Uploaded
cschu
parents:
diff changeset
64
df4163858937 Uploaded
cschu
parents:
diff changeset
65 <!-- <conditional name="libraryType">
df4163858937 Uploaded
cschu
parents:
diff changeset
66 <param name="libtype" type="select" label="Is this library single- or paired-end?">
df4163858937 Uploaded
cschu
parents:
diff changeset
67 <option value="single">Single-end</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
68 <option value="paired">Paired-end</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
69 </param>
df4163858937 Uploaded
cschu
parents:
diff changeset
70 <when value="single">
df4163858937 Uploaded
cschu
parents:
diff changeset
71 <param name="input1" type="data" format="fasta,fastq,fasta.gz,fasta.bz2,fa.gz,fq.gz,fa,fq" label="Fasta/Fastq file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
72 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
73 <when value="paired">
df4163858937 Uploaded
cschu
parents:
diff changeset
74 <param name="input1" type="data" format="fasta,fastq,fasta.gz,fasta.bz2,fa.gz,fq.gz,fa,fq" label="Left Fasta/Fastq file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
75 <param name="input2" type="data" format="fasta,fastq,fasta.gz,fasta.bz2,fa.gz,fq.gz,fa,fq" label="Right Fasta/Fastq file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
76 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
77 </conditional> -->
df4163858937 Uploaded
cschu
parents:
diff changeset
78 <conditional name="dataFormat">
df4163858937 Uploaded
cschu
parents:
diff changeset
79 <param name="inputFormat" type="select" label="Please select input file type and library type.">
df4163858937 Uploaded
cschu
parents:
diff changeset
80 <option value="singleFastQ">Single-end FastQ</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
81 <option value="pairedFastQ">Paired-end FastQ</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
82 <option value="singleFastA">Single-end FastA</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
83 <option value="pairedFastA">Paired-end FastA</option>
df4163858937 Uploaded
cschu
parents:
diff changeset
84 </param>
df4163858937 Uploaded
cschu
parents:
diff changeset
85 <when value="singleFastQ">
df4163858937 Uploaded
cschu
parents:
diff changeset
86 <param name="input1" type="data" format="fastq,fastqillumina,fastqsanger,fq" label="FastQ file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
87 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
88 <when value="pairedFastQ">
df4163858937 Uploaded
cschu
parents:
diff changeset
89 <param name="input1" type="data" format="fastq,fastqillumina,fastqsanger,fq" label="Forward/Left FastQ file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
90 <param name="input2" type="data" format="fastq,fastqillumina,fastqsanger,fq" label="Reverse/Right FastQ file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
91 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
92 <when value="singleFastA">
df4163858937 Uploaded
cschu
parents:
diff changeset
93 <param name="input1" type="data" format="fasta, fa" label="FastA file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
94 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
95 <when value="pairedFastA">
df4163858937 Uploaded
cschu
parents:
diff changeset
96 <param name="input1" type="data" format="fasta, fa" label="Forward/Left FASTA file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
97 <param name="input2" type="data" format="fasta, fa" label="Reverse/Right FASTA file" />
df4163858937 Uploaded
cschu
parents:
diff changeset
98 </when>
df4163858937 Uploaded
cschu
parents:
diff changeset
99 </conditional>
df4163858937 Uploaded
cschu
parents:
diff changeset
100
df4163858937 Uploaded
cschu
parents:
diff changeset
101
df4163858937 Uploaded
cschu
parents:
diff changeset
102 </inputs>
df4163858937 Uploaded
cschu
parents:
diff changeset
103 <outputs>
df4163858937 Uploaded
cschu
parents:
diff changeset
104 <data format="tabular" name="kraken_summary_tsv" label="${tool.name} output summary of ${on_string}" />
df4163858937 Uploaded
cschu
parents:
diff changeset
105 <!-- <data name="classified_seqs_fq" format_source="input1" label="${tool.name}-classified sequences from ${on_string}" />
df4163858937 Uploaded
cschu
parents:
diff changeset
106 <data name="unclassified_seqs_fq" format_source="input1" label="${tool.name}-unclassified sequences from ${on_string}" /> -->
df4163858937 Uploaded
cschu
parents:
diff changeset
107 </outputs>
df4163858937 Uploaded
cschu
parents:
diff changeset
108
df4163858937 Uploaded
cschu
parents:
diff changeset
109 <help>
df4163858937 Uploaded
cschu
parents:
diff changeset
110 This tool wraps the kraken taxonomic sequence classifier.
df4163858937 Uploaded
cschu
parents:
diff changeset
111 </help>
df4163858937 Uploaded
cschu
parents:
diff changeset
112 </tool>