annotate qiime2/qiime_feature-classifier_extract-reads.xml @ 6:de4c22a52df4 draft

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:46:48 -0400
parents 914fa4daf16a
children f190567fe3f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-classifier_extract-reads" name="qiime feature-classifier extract-reads" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Extract reads from reference</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
6
florianbegusch
parents: 4
diff changeset
8
florianbegusch
parents: 4
diff changeset
9
florianbegusch
parents: 4
diff changeset
10 #if str( $input_sequences.selector ) == 'history'
florianbegusch
parents: 4
diff changeset
11 #set $seq = $input_sequences.i_sequences
florianbegusch
parents: 4
diff changeset
12
florianbegusch
parents: 4
diff changeset
13 #else:
florianbegusch
parents: 4
diff changeset
14 qiime tools import --type 'FeatureData[Sequence]' --input-path '$input_sequences.i_sequences.fields.path' --output-path database.qza;
florianbegusch
parents: 4
diff changeset
15 #set $seq = 'database.qza'
florianbegusch
parents: 4
diff changeset
16 #end if
florianbegusch
parents: 4
diff changeset
17
florianbegusch
parents: 4
diff changeset
18
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 qiime feature-classifier extract-reads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
6
florianbegusch
parents: 4
diff changeset
21 --i-sequences=$seq
florianbegusch
parents: 4
diff changeset
22
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-f-primer="$pfprimer"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-r-primer="$prprimer"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
4
florianbegusch
parents: 0
diff changeset
26 #if str($ptrunclen):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-trunc-len=$ptrunclen
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
4
florianbegusch
parents: 0
diff changeset
30 #if str($ptrimleft):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-trim-left=$ptrimleft
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
4
florianbegusch
parents: 0
diff changeset
34 #if str($pidentity):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-identity=$pidentity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
4
florianbegusch
parents: 0
diff changeset
38 #if str($pminlength):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --p-min-length=$pminlength
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
4
florianbegusch
parents: 0
diff changeset
42 #if str($pmaxlength):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --p-max-length=$pmaxlength
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 --o-reads=oreads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 cp oreads.qza $oreads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <inputs>
6
florianbegusch
parents: 4
diff changeset
51 <conditional name="input_sequences" optional="False">
florianbegusch
parents: 4
diff changeset
52 <param name="selector" type="select" label="--i-sequences: FeatureData[Sequence] [required] - Reference sequences to query">
florianbegusch
parents: 4
diff changeset
53 <option value="cached">Public databases</option>
florianbegusch
parents: 4
diff changeset
54 <option value="history">Databases from your history</option>
florianbegusch
parents: 4
diff changeset
55 </param>
florianbegusch
parents: 4
diff changeset
56 <when value="cached">
florianbegusch
parents: 4
diff changeset
57 <param name="i_sequences" label="--i-sequences: FeatureData[Sequence] [required] - Reference sequences" type="select" optional="True">
florianbegusch
parents: 4
diff changeset
58 <options from_data_table="qiime_rep_set" />
florianbegusch
parents: 4
diff changeset
59 </param>
florianbegusch
parents: 4
diff changeset
60 </when>
florianbegusch
parents: 4
diff changeset
61 <when value="history">
florianbegusch
parents: 4
diff changeset
62 <param name="i_sequences" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
florianbegusch
parents: 4
diff changeset
63 </when>
florianbegusch
parents: 4
diff changeset
64 </conditional>
florianbegusch
parents: 4
diff changeset
65
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <param label="--p-f-primer: TEXT forward primer sequence [required]" name="pfprimer" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-r-primer: TEXT reverse primer sequence [required]" name="prprimer" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-trunc-len: INTEGER read is cut to trunc-len if trunc-len is positive. Applied before trim-left. [default: 0]" name="ptrunclen" optional="True" type="integer" value="0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-trim-left: INTEGER trim-left nucleotides are removed from the 5' end if trim-left is positive. Applied after trunc-len. [default: 0]" name="ptrimleft" optional="True" type="integer" value="0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-identity: NUMBER minimum combined primer match identity threshold. [default: 0.8]" name="pidentity" optional="True" type="float" value="0.8"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-min-length: INTEGER Minimum amplicon length. Shorter amplicons are Range(0, None) discarded. Applied after trimming and truncation, so be aware that trimming may impact sequence retention. Set to zero to disable min length filtering. [default: 50]" name="pminlength" optional="True" type="integer" min="0" value="50"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <param label="--p-max-length: INTEGER Maximum amplicon length. Longer amplicons are Range(0, None) discarded. Applied before trimming and truncation, so plan accordingly. Set to zero (default) to disable max length filtering. [default: 0]" name="pmaxlength" optional="True" type="integer" min="0" value="0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <data format="qza" label="${tool.name} on ${on_string}: reads.qza" name="oreads"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 Extract reads from reference
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 ############################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Extract sequencing-like reads from a reference database.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 \
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 f_primer : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 forward primer sequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 r_primer : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 reverse primer sequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 trunc_len : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 read is cut to trunc_len if trunc_len is positive. Applied before
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 trim_left.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 trim_left : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 trim_left nucleotides are removed from the 5' end if trim_left is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 positive. Applied after trunc_len.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 identity : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 minimum combined primer match identity threshold.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 min_length : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 Minimum amplicon length. Shorter amplicons are discarded. Applied after
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 trimming and truncation, so be aware that trimming may impact sequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 retention. Set to zero to disable min length filtering.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 max_length : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Maximum amplicon length. Longer amplicons are discarded. Applied before
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 trimming and truncation, so plan accordingly. Set to zero (default) to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 disable max length filtering.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 reads : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 </tool>