annotate qiime2-2020.8/qiime_fragment-insertion_sepp.xml @ 22:292c84bd5ab6 draft

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