annotate qiime2/qiime_fragment-insertion_sepp.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_fragment-insertion_sepp" name="qiime fragment-insertion sepp"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Insert fragment sequences using SEPP into reference phylogenies.</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime fragment-insertion sepp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-representative-sequences=$irepresentativesequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --i-reference-database=$ireferencedatabase
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-alignment-subset-size=$palignmentsubsetsize
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --p-placement-subset-size=$pplacementsubsetsize
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 --p-threads=$pthreads
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pdebug:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 --p-debug
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 --o-tree=otree
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 --o-placements=oplacements
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 cp oplacements.qza $oplacements
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <param format="qza,no_unzip.zip" label="--i-representative-sequences: ARTIFACT FeatureData[Sequence] The sequences to insert into the reference tree. [required]" name="irepresentativesequences" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <param format="qza,no_unzip.zip" label="--i-reference-database: ARTIFACT SeppReferenceDatabase The reference database to insert the representative sequences into. [required]" name="ireferencedatabase" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--p-alignment-subset-size: INTEGER Each placement subset is further broken into subsets of at most these many sequences and a separate HMM is trained on each subset. [default: 1000]" name="palignmentsubsetsize" optional="True" type="integer" value="1000" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-placement-subset-size: INTEGER The tree is divided into subsets such that each subset includes at most these many subsets. The placement step places the fragment on only one subset, determined based on alignment scores. Further reading: https://github.com/smirarab/sepp/blob/master/tutorial/s epp-tutorial.md#sample-datasets-default-parameters. [default: 5000]" name="pplacementsubsetsize" optional="True" type="integer" value="5000" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-debug: --p-debug: / --p-no-debug Collect additional run information to STDOUT for debugging. Temporary directories will not be removed if run fails. [default: False]" name="pdebug" selected="False" type="boolean" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 <data format="qza" label="${tool.name} on ${on_string}: tree.qza" name="otree" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <data format="qza" label="${tool.name} on ${on_string}: placements.qza" name="oplacements" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 Insert fragment sequences using SEPP into reference phylogenies.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 Perform fragment insertion of sequences using the SEPP algorithm.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 representative_sequences : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 The sequences to insert into the reference tree.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 reference_database : SeppReferenceDatabase
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 The reference database to insert the representative sequences into.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 alignment_subset_size : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 Each placement subset is further broken into subsets of at most these
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 many sequences and a separate HMM is trained on each subset.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 placement_subset_size : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 The tree is divided into subsets such that each subset includes at most
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 these many subsets. The placement step places the fragment on only one
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 subset, determined based on alignment scores. Further reading:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 https://github.com/smirarab/sepp/blob/master/tutorial/sepp-
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 tutorial.md#sample-datasets-default-parameters.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 threads : Int, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 The number of threads to use.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 debug : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 Collect additional run information to STDOUT for debugging. Temporary
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 directories will not be removed if run fails.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 tree : Phylogeny[Rooted]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 The tree with inserted feature data.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 placements : Placements
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 Information about the feature placements within the reference tree.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 </tool>