annotate qiime2/qiime_fragment-insertion_sepp.xml @ 4:71f124e02000 draft default tip

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:40:25 -0400
parents 149432539226
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_fragment-insertion_sepp" name="qiime fragment-insertion sepp" version="2019.4">
149432539226 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Insert fragment sequences using SEPP into reference phylogenies like Greengenes 13_8</description>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
8 qiime fragment-insertion sepp
149432539226 Uploaded
florianbegusch
parents:
diff changeset
9
149432539226 Uploaded
florianbegusch
parents:
diff changeset
10 --i-representative-sequences=$irepresentativesequences
149432539226 Uploaded
florianbegusch
parents:
diff changeset
11
149432539226 Uploaded
florianbegusch
parents:
diff changeset
12 #if str($ireferencealignment) != 'None':
149432539226 Uploaded
florianbegusch
parents:
diff changeset
13 --i-reference-alignment=$ireferencealignment
149432539226 Uploaded
florianbegusch
parents:
diff changeset
14 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
15
149432539226 Uploaded
florianbegusch
parents:
diff changeset
16 #if str($ireferencephylogeny) != 'None':
149432539226 Uploaded
florianbegusch
parents:
diff changeset
17 --i-reference-phylogeny=$ireferencephylogeny
149432539226 Uploaded
florianbegusch
parents:
diff changeset
18 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
19
149432539226 Uploaded
florianbegusch
parents:
diff changeset
20 #set $pthreads = '${GALAXY_SLOTS:-4}'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($pthreads):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
22 --p-threads="$pthreads"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
24
149432539226 Uploaded
florianbegusch
parents:
diff changeset
25
4
florianbegusch
parents: 2
diff changeset
26 #if str($palignmentsubsetsize):
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
27 --p-alignment-subset-size=$palignmentsubsetsize
149432539226 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
29
149432539226 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($pplacementsubsetsize):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
31 --p-placement-subset-size="$pplacementsubsetsize"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
33
149432539226 Uploaded
florianbegusch
parents:
diff changeset
34 --o-tree=otree
149432539226 Uploaded
florianbegusch
parents:
diff changeset
35 --o-placements=oplacements
149432539226 Uploaded
florianbegusch
parents:
diff changeset
36 ;
149432539226 Uploaded
florianbegusch
parents:
diff changeset
37 cp otree.qza $otree;
149432539226 Uploaded
florianbegusch
parents:
diff changeset
38 cp oplacements.qza $oplacements
149432539226 Uploaded
florianbegusch
parents:
diff changeset
39 ]]></command>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
40 <inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
41 <param format="qza,no_unzip.zip" label="--i-representative-sequences: ARTIFACT FeatureData[Sequence] The sequences to insert [required]" name="irepresentativesequences" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
42 <param format="qza,no_unzip.zip" label="--i-reference-alignment: ARTIFACT FeatureData[AlignedSequence] The reference multiple nucleotide alignment used to construct the reference phylogeny. [optional]" name="ireferencealignment" optional="True" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
43 <param format="qza,no_unzip.zip" label="--i-reference-phylogeny: ARTIFACT Phylogeny[Rooted] The rooted reference phylogeny. Must be in sync with reference-alignment, i.e. each tip name must have exactly one corresponding record. [optional]" name="ireferencephylogeny" optional="True" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
44 <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. The default alignment subset size is set to balance the exhaustiveness of the alignment step with the running time. [default: 1000]" name="palignmentsubsetsize" optional="True" type="integer" value="1000"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
45 <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. The default placement subset is set to make sure the memory requirement of the pplacer step does not become prohibitively large." name="pplacementsubsetsize" optional="True" type="integer"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
46 </inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
47 <outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
48 <data format="qza" label="${tool.name} on ${on_string}: tree.qza" name="otree"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
49 <data format="qza" label="${tool.name} on ${on_string}: placements.qza" name="oplacements"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
50 </outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
51 <help><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
52 Insert fragment sequences using SEPP into reference phylogenies like Greengenes 13_8
149432539226 Uploaded
florianbegusch
parents:
diff changeset
53 ####################################################################################
149432539226 Uploaded
florianbegusch
parents:
diff changeset
54
149432539226 Uploaded
florianbegusch
parents:
diff changeset
55 Perform fragment insertion of 16S sequences using the SEPP algorithm
149432539226 Uploaded
florianbegusch
parents:
diff changeset
56 against the Greengenes 13_8 99% tree.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
57
149432539226 Uploaded
florianbegusch
parents:
diff changeset
58 Parameters
149432539226 Uploaded
florianbegusch
parents:
diff changeset
59 ----------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
60 representative_sequences : FeatureData[Sequence]
149432539226 Uploaded
florianbegusch
parents:
diff changeset
61 The sequences to insert
149432539226 Uploaded
florianbegusch
parents:
diff changeset
62 alignment_subset_size : Int, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
63 Each placement subset is further broken into subsets of at most these
149432539226 Uploaded
florianbegusch
parents:
diff changeset
64 many sequences and a separate HMM is trained on each subset. The
149432539226 Uploaded
florianbegusch
parents:
diff changeset
65 default alignment subset size is set to balance the exhaustiveness of
149432539226 Uploaded
florianbegusch
parents:
diff changeset
66 the alignment step with the running time.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
67 placement_subset_size : Int, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
68 The tree is divided into subsets such that each subset includes at most
149432539226 Uploaded
florianbegusch
parents:
diff changeset
69 these many subsets. The placement step places the fragment on only one
149432539226 Uploaded
florianbegusch
parents:
diff changeset
70 subset, determined based on alignment scores. The default placement
149432539226 Uploaded
florianbegusch
parents:
diff changeset
71 subset is set to make sure the memory requirement of the pplacer step
149432539226 Uploaded
florianbegusch
parents:
diff changeset
72 does not become prohibitively large. Further reading:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
73 https://github.com/smirarab/sepp/blob/master/tutorial/sepp-
149432539226 Uploaded
florianbegusch
parents:
diff changeset
74 tutorial.md#sample-datasets-default-parameters
149432539226 Uploaded
florianbegusch
parents:
diff changeset
75 reference_alignment : FeatureData[AlignedSequence], optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
76 The reference multiple nucleotide alignment used to construct the
149432539226 Uploaded
florianbegusch
parents:
diff changeset
77 reference phylogeny.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
78 reference_phylogeny : Phylogeny[Rooted], optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
79 The rooted reference phylogeny. Must be in sync with reference-
149432539226 Uploaded
florianbegusch
parents:
diff changeset
80 alignment, i.e. each tip name must have exactly one corresponding
149432539226 Uploaded
florianbegusch
parents:
diff changeset
81 record.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
82 debug : Bool, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
83 Print additional run information to STDOUT for debugging. Run together
149432539226 Uploaded
florianbegusch
parents:
diff changeset
84 with --verbose to actually see the information on STDOUT. Temporary
149432539226 Uploaded
florianbegusch
parents:
diff changeset
85 directories will not be removed if run fails.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
86
149432539226 Uploaded
florianbegusch
parents:
diff changeset
87 Returns
149432539226 Uploaded
florianbegusch
parents:
diff changeset
88 -------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
89 tree : Phylogeny[Rooted]
149432539226 Uploaded
florianbegusch
parents:
diff changeset
90 The tree with inserted feature data
149432539226 Uploaded
florianbegusch
parents:
diff changeset
91 placements : Placements
149432539226 Uploaded
florianbegusch
parents:
diff changeset
92 \
149432539226 Uploaded
florianbegusch
parents:
diff changeset
93 ]]></help>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
94 <macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
95 <import>qiime_citation.xml</import>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
96 </macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
97 <expand macro="qiime_citation"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
98 </tool>