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