annotate qiime2-2020.8/qiime_fragment-insertion_filter-features.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_fragment-insertion_filter-features" name="qiime fragment-insertion filter-features"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Filter fragments in tree from table.</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime fragment-insertion filter-features
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 --i-tree=$itree
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 --o-filtered-table=ofilteredtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 --o-removed-table=oremovedtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24 cp oremovedtable.qza $oremovedtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] A feature-table which needs to filtered down to those fragments that are contained in the tree, e.g. result of a Deblur or DADA2 run. [required]" name="itable" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT The tree resulting from inserting fragments into a Phylogeny[Rooted] reference phylogeny, i.e. the output of function \'sepp\' [required]" name="itree" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 <data format="qza" label="${tool.name} on ${on_string}: filteredtable.qza" name="ofilteredtable" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36 <data format="qza" label="${tool.name} on ${on_string}: removedtable.qza" name="oremovedtable" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41 Filter fragments in tree from table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44 Filters fragments not inserted into a phylogenetic tree from a feature-
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45 table. Some fragments computed by e.g. Deblur or DADA2 are too remote to
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 get inserted by SEPP into a reference phylogeny. To be able to use the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 feature-table for downstream analyses like computing Faith's PD or UniFrac,
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 the feature-table must be cleared of fragments that are not part of the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 phylogenetic tree, because their path length can otherwise not be
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50 determined. Typically, the number of rejected fragments is low (<= 10), but
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 it might be worth to inspect the ratio of reads assigned to those rejected
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 fragments.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 A feature-table which needs to filtered down to those fragments that
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 are contained in the tree, e.g. result of a Deblur or DADA2 run.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 tree : Phylogeny[Rooted]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 The tree resulting from inserting fragments into a reference phylogeny,
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 i.e. the output of function 'sepp'
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 filtered_table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 The input table minus those fragments that were not part of the tree.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 This feature-table can be used for downstream analyses like
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68 phylogenetic alpha- or beta- diversity computation.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 removed_table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 Those fragments that got removed from the input table, because they
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 were not part of the tree. This table is mainly used for quality
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 control, e.g. to inspect the ratio of removed reads per sample from the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 input table. You can ignore this table for downstream analyses.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 </tool>