annotate qiime2/qiime_fragment-insertion_filter-features.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents 370e0b6e9826
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_fragment-insertion_filter-features" name="qiime fragment-insertion filter-features" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Filter fragments in tree from table.</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[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime fragment-insertion filter-features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-tree=$itree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --o-filtered-table=ofilteredtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --o-removed-table=oremovedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 cp ofilteredtable.qza $ofilteredtable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 cp oremovedtable.qza $oremovedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 <data format="qza" label="${tool.name} on ${on_string}: filteredtable.qza" name="ofilteredtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 <data format="qza" label="${tool.name} on ${on_string}: removedtable.qza" name="oremovedtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 Filter fragments in tree from table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 ####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 Filters fragments not inserted into a phylogenetic tree from a feature-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 table. Some fragments computed by e.g. Deblur or DADA2 are too remote to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 get inserted by SEPP into a reference phylogeny. To be able to use the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 feature-table for downstream analyses like computing Faith's PD or UniFrac,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 the feature-table must be cleared of fragments that are not part of the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 phylogenetic tree, because their path length can otherwise not be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 determined. Typically, the number of rejected fragments is low (<= 10), but
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 it might be worth to inspect the ratio of reads assigned to those rejected
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 fragments.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 A feature-table which needs to filtered down to those fragments that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 are contained in the tree, e.g. result of a Deblur or DADA2 run.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 tree : Phylogeny[Rooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 The tree resulting from inserting fragments into a reference phylogeny,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 i.e. the output of function 'sepp'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 filtered_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 The input table minus those fragments that were not part of the tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 This feature-table can be used for downstream analyses like
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 phylogenetic alpha- or beta- diversity computation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 removed_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 Those fragments that got removed from the input table, because they
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 were not part of the tree. This table is mainly used for quality
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 control, e.g. to inspect the ratio of removed reads per sample from the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 input table. You can ignore this table for downstream analyses.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 </tool>