annotate qiime2-2020.8/qiime_quality-control_filter-reads.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_quality-control_filter-reads" name="qiime quality-control filter-reads"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Filter demultiplexed sequences by alignment to reference database.</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime quality-control filter-reads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-demultiplexed-sequences=$idemultiplexedsequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --i-database=$idatabase
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 --p-n-threads=$pnthreads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pmode) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 --p-mode=$pmode
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($psensitivity) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --p-sensitivity=$psensitivity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 --p-ref-gap-open-penalty=$prefgapopenpenalty
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 --p-ref-gap-ext-penalty=$prefgapextpenalty
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 #if $pnoexcludeseqs:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 --p-no-exclude-seqs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 --o-filtered-sequences=ofilteredsequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 cp ofilteredsequences.qza $ofilteredsequences
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 <param format="qza,no_unzip.zip" label="--i-demultiplexed-sequences: ARTIFACT SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality²] The sequences to be trimmed. [required]" name="idemultiplexedsequences" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 <param format="qza,no_unzip.zip" label="--i-database: ARTIFACT Bowtie2 indexed database. Bowtie2Index [required]" name="idatabase" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 <param label="--p-mode: " name="pmode" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="local">local</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="global">global</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--p-sensitivity: " name="psensitivity" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="very-fast">very-fast</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="fast">fast</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="sensitive">sensitive</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="very-sensitive">very-sensitive</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--p-ref-gap-open-penalty: INTEGER Range(1, None) Reference gap open penalty. [default: 5]" min="1" name="prefgapopenpenalty" optional="True" type="integer" value="5" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-ref-gap-ext-penalty: INTEGER Range(1, None) Reference gap extend penalty. [default: 3]" min="1" name="prefgapextpenalty" optional="True" type="integer" value="3" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 <param label="--p-no-exclude-seqs: Do not exclude sequences that align to reference. Set this option to False to exclude sequences that do not align to the reference database. [default: True]" name="pnoexcludeseqs" selected="False" type="boolean" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 <data format="qza" label="${tool.name} on ${on_string}: filteredsequences.qza" name="ofilteredsequences" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 Filter demultiplexed sequences by alignment to reference database.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 Filter out (or keep) demultiplexed single- or paired-end sequences that
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 align to a reference database, using bowtie2 and samtools. This method can
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 be used to filter out human DNA sequences and other contaminants in any
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 FASTQ sequence data (e.g., shotgun genome or amplicon sequence data), or
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 alternatively (when exclude_seqs is False) to only keep sequences that do
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 align to the reference.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 demultiplexed_sequences : SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality²]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 The sequences to be trimmed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 database : Bowtie2Index
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 Bowtie2 indexed database.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 n_threads : Int % Range(1, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 Number of alignment threads to launch.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 mode : Str % Choices('local', 'global'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 Bowtie2 alignment settings. See bowtie2 manual for more details.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 sensitivity : Str % Choices('very-fast', 'fast', 'sensitive', 'very-sensitive'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92 Bowtie2 alignment sensitivity. See bowtie2 manual for details.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 ref_gap_open_penalty : Int % Range(1, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 Reference gap open penalty.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 ref_gap_ext_penalty : Int % Range(1, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 Reference gap extend penalty.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 exclude_seqs : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 Exclude sequences that align to reference. Set this option to False to
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 exclude sequences that do not align to the reference database.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
102 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
103 filtered_sequences : SampleData[SequencesWithQuality¹ | PairedEndSequencesWithQuality²]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
104 The resulting filtered sequences.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
105 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
106 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
107 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
108 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
109 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
110 </tool>