annotate qiime2/qiime_feature-classifier_extract-reads.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents f190567fe3f6
children
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" ?>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
2 <tool id="qiime_feature-classifier_extract-reads" name="qiime feature-classifier extract-reads"
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
4 <description>Extract reads from reference sequences.</description>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
8 <command><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-classifier extract-reads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
11 --i-sequences=$isequences
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
12
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
13 --p-f-primer=$pfprimer
6
florianbegusch
parents: 4
diff changeset
14
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 --p-r-primer=$prprimer
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 --p-trim-right=$ptrimright
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
18
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 --p-trunc-len=$ptrunclen
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 --p-trim-left=$ptrimleft
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
22
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
23 --p-identity=$pidentity
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
24
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
25 --p-min-length=$pminlength
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
27 --p-max-length=$pmaxlength
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
29 --p-n-jobs=$pnjobs
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
31 #if str($preadorientation) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
32 --p-read-orientation=$preadorientation
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --o-reads=oreads
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
36
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
37 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
38 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 cp oreads.qza $oreads
6
florianbegusch
parents: 4
diff changeset
43
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
45 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
46 <param format="qza,no_unzip.zip" label="--i-sequences: ARTIFACT FeatureData[Sequence] [required]" name="isequences" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
47 <param label="--p-f-primer: TEXT forward primer sequence (5\' -&gt; 3\'). [required]" name="pfprimer" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
48 <param label="--p-r-primer: TEXT reverse primer sequence (5\' -&gt; 3\'). Do not use reverse-complemented primer sequence. [required]" name="prprimer" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
49 <param label="--p-trim-right: INTEGER trim-right nucleotides are removed from the 3\' end if trim-right is positive. Applied before trunc-len and trim-left. [default: 0]" name="ptrimright" optional="True" type="integer" value="0" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
50 <param label="--p-trunc-len: INTEGER read is cut to trunc-len if trunc-len is positive. Applied after trim-right but before trim-left. [default: 0]" name="ptrunclen" optional="True" type="integer" value="0" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
51 <param label="--p-trim-left: INTEGER trim-left nucleotides are removed from the 5\' end if trim-left is positive. Applied after trim-right and trunc-len. [default: 0]" name="ptrimleft" optional="True" type="integer" value="0" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52 <param label="--p-identity: NUMBER minimum combined primer match identity threshold. [default: 0.8]" name="pidentity" optional="True" type="float" value="0.8" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 <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]" min="0" name="pminlength" optional="True" type="integer" value="50" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54 <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]" min="0" name="pmaxlength" optional="True" type="integer" value="0" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55 <param label="--p-read-orientation: " name="preadorientation" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
56 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57 <option value="both">both</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
58 <option value="forward">forward</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
59 <option value="reverse">reverse</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60 </param>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
61 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
62
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
63 </inputs>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
65 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
66 <data format="qza" label="${tool.name} on ${on_string}: reads.qza" name="oreads" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
67
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
68 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
69
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
70 <help><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
71 Extract reads from reference sequences.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
72 ###############################################################
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
73
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
74 Extract simulated amplicon reads from a reference database. Performs in-
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
75 silico PCR to extract simulated amplicons from reference sequences that
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
76 match the input primer sequences (within the mismatch threshold specified
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
77 by `identity`). Both primer sequences must be in the 5' -> 3' orientation.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
78 Sequences that fail to match both primers will be excluded. Reads are
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
79 extracted, trimmed, and filtered in the following order: 1. reads are
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
80 extracted in specified orientation; 2. primers are removed; 3. reads longer
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
81 than `max_length` are removed; 4. reads are trimmed with `trim_right`; 5.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
82 reads are truncated to `trunc_len`; 6. reads are trimmed with `trim_left`;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
83 7. reads shorter than `min_length` are removed.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 f_primer : Str
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
89 forward primer sequence (5' -> 3').
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 r_primer : Str
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
91 reverse primer sequence (5' -> 3'). Do not use reverse-complemented
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
92 primer sequence.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
93 trim_right : Int, optional
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
94 trim_right nucleotides are removed from the 3' end if trim_right is
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
95 positive. Applied before trunc_len and trim_left.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 trunc_len : Int, optional
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
97 read is cut to trunc_len if trunc_len is positive. Applied after
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
98 trim_right but before trim_left.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 trim_left : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 trim_left nucleotides are removed from the 5' end if trim_left is
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
101 positive. Applied after trim_right and trunc_len.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 identity : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 minimum combined primer match identity threshold.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 min_length : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Minimum amplicon length. Shorter amplicons are discarded. Applied after
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 trimming and truncation, so be aware that trimming may impact sequence
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 retention. Set to zero to disable min length filtering.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 max_length : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 Maximum amplicon length. Longer amplicons are discarded. Applied before
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 trimming and truncation, so plan accordingly. Set to zero (default) to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 disable max length filtering.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
112 n_jobs : Int % Range(1, None), optional
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
113 Number of seperate processes to run.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
114 batch_size : Int % Range(1, None) | Str % Choices('auto'), optional
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
115 Number of sequences to process in a batch. The `auto` option is
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
116 calculated from the number of sequences and number of jobs specified.
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
117 read_orientation : Str % Choices('both', 'forward', 'reverse'), optional
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
118 Orientation of primers relative to the sequences: "forward" searches
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
119 for primer hits in the forward direction, "reverse" searches reverse-
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
120 complement, and "both" searches both directions.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 reads : FeatureData[Sequence]
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
125 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
126 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
128 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
129 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
130 </tool>