annotate gene_family_phylogeny_builder.xml @ 58:a120d3af913a draft

Uploaded
author greg
date Wed, 29 Aug 2018 14:23:38 -0400
parents a996421f4eea
children 5a19408e97f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
a996421f4eea Uploaded
greg
parents: 56
diff changeset
1 <tool id="plant_tribes_gene_family_phylogeny_builder" name="GeneFamilyPhylogenyBuilder" version="@WRAPPER_VERSION@.3.1">
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
2 <description>builds phylogenetic trees of aligned orthologous gene family clusters</description>
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
3 <macros>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
4 <import>macros.xml</import>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
5 </macros>
51
9962341547d3 Uploaded
greg
parents: 50
diff changeset
6 <requirements>
9962341547d3 Uploaded
greg
parents: 50
diff changeset
7 <requirement type="package" version="1.0.3">plant_tribes_gene_family_phylogeny_builder</requirement>
9962341547d3 Uploaded
greg
parents: 50
diff changeset
8 </requirements>
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
46
8262754dc5f9 Uploaded
greg
parents: 44
diff changeset
10 #set input_dir = 'input_dir'
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
11 #set tree_inference = $tree_inference_cond.tree_inference
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
12 #if str($tree_inference) == 'raxml':
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
13 #set scaffold = $tree_inference_cond.scaffold
24774c743d31 Uploaded
greg
parents: 52
diff changeset
14 #set method = $tree_inference_cond.method
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
15 #set rooting_order_file_cond = $tree_inference_cond.rooting_order_file_cond
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
16 #set rooting_order_file = $rooting_order_file_cond.rooting_order_file
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
17 #if str($rooting_order_file) == 'yes':
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
18 #set rooting_order = $rooting_order_file_cond.rooting_order
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
19 #end if
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
20 #set bootstrap_replicates = $tree_inference_cond.bootstrap_replicates
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
21 #end if
46
8262754dc5f9 Uploaded
greg
parents: 44
diff changeset
22 mkdir $input_dir &&
47
22d6092baa99 Uploaded
greg
parents: 46
diff changeset
23 #for $i in $input:
48
0c9847a598fc Uploaded
greg
parents: 47
diff changeset
24 #set filename = $i.file_name
51
9962341547d3 Uploaded
greg
parents: 50
diff changeset
25 #set name = $i.name
50
4c9a4aa6adce Uploaded
greg
parents: 49
diff changeset
26 ln -s $filename $input_dir/$name &&
46
8262754dc5f9 Uploaded
greg
parents: 44
diff changeset
27 #end for
43
7124b199fe03 Uploaded
greg
parents: 42
diff changeset
28 GeneFamilyPhylogenyBuilder
46
8262754dc5f9 Uploaded
greg
parents: 44
diff changeset
29 --orthogroup_aln '$input_dir'
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
30 --tree_inference $tree_inference
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
31 #if str($tree_inference) == 'raxml':
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
32 --scaffold '$scaffold.fields.path'
24774c743d31 Uploaded
greg
parents: 52
diff changeset
33 --config_dir '$scaffold.fields.path'
24774c743d31 Uploaded
greg
parents: 52
diff changeset
34 --method $method
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
35 #if str($rooting_order_file) == 'yes':
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
36 --rooting_order '$rooting_order'
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
37 ## No else block needed here because the default rooting_order
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
38 ## configuration will be used if the --rooting_order flag is missing.
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
39 #end if
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
40 --bootstrap_replicates $bootstrap_replicates
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
41 #end if
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
42 --min_orthogroup_size $min_orthogroup_size
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
43 --max_orthogroup_size $max_orthogroup_size
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
44 --num_threads \${GALAXY_SLOTS:-4}
56
178971bba68f Uploaded
greg
parents: 54
diff changeset
45 &>gene_family_phylogeny_builder_log.txt;
178971bba68f Uploaded
greg
parents: 54
diff changeset
46 if [[ $? -ne 0 ]]; then
178971bba68f Uploaded
greg
parents: 54
diff changeset
47 find geneFamilyPhylogenies_dir -type d -maxdepth 1 -exec cp gene_family_phylogeny_builder_log.txt {} \;
178971bba68f Uploaded
greg
parents: 54
diff changeset
48 exit 1;
178971bba68f Uploaded
greg
parents: 54
diff changeset
49 fi
38
d818f553ce5a Uploaded
greg
parents: 36
diff changeset
50 ]]></command>
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
51 <inputs>
46
8262754dc5f9 Uploaded
greg
parents: 44
diff changeset
52 <param name="input" format="fasta" type="data_collection" collection_type="list" label="Proteins orthogroup alignments" />
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
53 <conditional name="tree_inference_cond">
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
54 <param name="tree_inference" type="select" label="Phylogenetic inference method">
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
55 <option value="raxml" selected="true">RAxML</option>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
56 <option value="fasttree">FastTree</option>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
57 </param>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
58 <when value="raxml">
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
59 <expand macro="param_scaffold" />
24774c743d31 Uploaded
greg
parents: 52
diff changeset
60 <expand macro="param_method" />
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
61 <conditional name="rooting_order_file_cond">
7
c03437a39e08 Uploaded
greg
parents: 6
diff changeset
62 <param name="rooting_order_file" type="select" label="Rooting order configuration">
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
63 <option value="no" selected="true">No</option>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
64 <option value="yes">Yes</option>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
65 </param>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
66 <when value="no" />
f4361d941aa3 Uploaded
greg
parents:
diff changeset
67 <when value="yes">
11
0307ab4f5031 Uploaded
greg
parents: 10
diff changeset
68 <param name="rooting_order" format="txt" type="data" label="Rooting order configuration" />
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
69 </when>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
70 </conditional>
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
71 <param name="bootstrap_replicates" type="integer" value="100" min="0" label="Bootstrap replicates" />
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
72 </when>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
73 <when value="fasttree" />
f4361d941aa3 Uploaded
greg
parents:
diff changeset
74 </conditional>
27
6374c987b4a8 Uploaded
greg
parents: 26
diff changeset
75 <param name="max_orthogroup_size" type="integer" value="100" min="4" label="Maximum orthogroup size" />
6374c987b4a8 Uploaded
greg
parents: 26
diff changeset
76 <param name="min_orthogroup_size" type="integer" value="4" min="4" label="Minimum orthogroup size" />
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
77 </inputs>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
78 <outputs>
43
7124b199fe03 Uploaded
greg
parents: 42
diff changeset
79 <collection name="tree" type="list" label="${tool.name} (phylogenetic trees) on ${on_string}">
57
a996421f4eea Uploaded
greg
parents: 56
diff changeset
80 <discover_datasets pattern="__name__" directory="geneFamilyPhylogenies_dir/orthogroups_tree" format="newick" />
29
3d78d366dfcc Uploaded
greg
parents: 27
diff changeset
81 </collection>
43
7124b199fe03 Uploaded
greg
parents: 42
diff changeset
82 <collection name="phylip" type="list" label="${tool.name} (orthogroup phylip multiple sequence alignments) on ${on_string}">
25
e6f16430822d Uploaded
greg
parents: 23
diff changeset
83 <filter>tree_inference_cond['tree_inference'] == 'raxml'</filter>
43
7124b199fe03 Uploaded
greg
parents: 42
diff changeset
84 <discover_datasets pattern="__name__" directory="geneFamilyPhylogenies_dir/phylip_aln" format="phylip" />
7124b199fe03 Uploaded
greg
parents: 42
diff changeset
85 </collection>
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
86 </outputs>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
87 <tests>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
88 <test>
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
89 <param name="input">
24774c743d31 Uploaded
greg
parents: 52
diff changeset
90 <collection type="list">
24774c743d31 Uploaded
greg
parents: 52
diff changeset
91 <element name="3722.faa.aln" value="3722.faa.aln"/>
24774c743d31 Uploaded
greg
parents: 52
diff changeset
92 </collection>
24774c743d31 Uploaded
greg
parents: 52
diff changeset
93 </param>
54
eef0f4704dca Uploaded
greg
parents: 53
diff changeset
94 <param name="tree_inference" value="fasttree"/>
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
95 <output_collection name="tree" type="list">
57
a996421f4eea Uploaded
greg
parents: 56
diff changeset
96 <element name="3722.faa.aln.tree" file="3722.faa.aln.tree" ftype="newick"/>
53
24774c743d31 Uploaded
greg
parents: 52
diff changeset
97 </output_collection>
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
98 </test>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
99 </tests>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
100 <help>
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
101 This tool is one of the PlantTribes collection of automated modular analysis pipelines for comparative and evolutionary
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
102 analyses of genome-scale gene families and transcriptomes. This tool performs gene family phylogenetic inference of
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
103 multiple sequence alignments produced by the GeneFamilyAligner tool.
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
104
f4361d941aa3 Uploaded
greg
parents:
diff changeset
105 -----
f4361d941aa3 Uploaded
greg
parents:
diff changeset
106
f4361d941aa3 Uploaded
greg
parents:
diff changeset
107 **Required options**
f4361d941aa3 Uploaded
greg
parents:
diff changeset
108
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
109 * **Orthogroup alignments** - orthogroup alignment fasta files produced by the GeneFamilyAligner tool selected from your history. Depending on how the GeneFamilyAligner tool was executed, these could either be pre-processed alignments, trimmed alignments or both trimmed and filtered alignments.
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
110 * **Phylogenetic inference method** - method for estimating orthogroup maximum likelihood (ML) phylogenetic trees. PlantTribes estimates ML phylogenetic trees using either RAxML or FastTree algorithms.
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
111
54
eef0f4704dca Uploaded
greg
parents: 53
diff changeset
112 - **Gene family scaffold** - one of the PlantTribes gene family scaffolds installed into Galaxy by the PlantTribes Scaffold Download Data Manager tool. This is used only if RAxML is selected as the phylogenetic inference method.
eef0f4704dca Uploaded
greg
parents: 53
diff changeset
113 - **Protein clustering method** - gene family scaffold protein clustering method as described in the AssemblyPostProcessor tool. This is used only if RAxML is selected as the phylogenetic inference method.
eef0f4704dca Uploaded
greg
parents: 53
diff changeset
114
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
115 **Other options**
f4361d941aa3 Uploaded
greg
parents:
diff changeset
116
7
c03437a39e08 Uploaded
greg
parents: 6
diff changeset
117 * **Rooting order configuration** - select 'Yes' to enable selection of a rooting order configuration file for RAxML. Scaffold configuration templates (.rootingOrder.config) of how to customize the RAxML ML tree rooting order can be found in the scaffold data installed into Galaxy via the PlantTribes Scaffolds Download Data Manager tool, and is also available at the PlantTribes GitHub `repository`_. Phylogenetic tree rooting order settings shown in these templates are used as defaults if 'No' is selected.
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
118 * **Bootstrap replicates** - number of bootstrap replicates for RAxML to conduct a rapid bootstrap analysis and search for the best-scoring ML tree (default = 100).
11
0307ab4f5031 Uploaded
greg
parents: 10
diff changeset
119 * **Maximum orthogroup size** - maximum number of sequences allowed in orthogroup alignments (default = 100).
0307ab4f5031 Uploaded
greg
parents: 10
diff changeset
120 * **Minimum orthogroup size** - minimum number of sequences allowed in orthogroup alignments (default = 4).
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
121
9
b7b1d6ebcfd4 Uploaded
greg
parents: 7
diff changeset
122 .. _repository: https://github.com/dePamphilis/PlantTribes/tree/master/config
b7b1d6ebcfd4 Uploaded
greg
parents: 7
diff changeset
123
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
124 </help>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
125 <citations>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
126 <expand macro="citation1" />
6
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
127 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
128 @article{Wall2008,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
129 journal = {Nucleic Acids Research},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
130 author = {2. Wall PK, Leebens-Mack J, Muller KF, Field D, Altman NS},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
131 title = {PlantTribes: a gene and gene family resource for comparative genomics in plants},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
132 year = {2008},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
133 volume = {36},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
134 number = {suppl 1},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
135 pages = {D970-D976},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
136 </citation>
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
137 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
138 @article{Sasidharan2012,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
139 journal = {Nucleic Acids Research},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
140 author = {3. Sasidharan R, Nepusz T, Swarbreck D, Huala E, Paccanaro A},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
141 title = {GFam: a platform for automatic annotation of gene families},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
142 year = {2012},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
143 pages = {gks631},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
144 </citation>
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
145 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
146 @article{Li2003,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
147 journal = {Genome Research}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
148 author = {4. Li L, Stoeckert CJ, Roos DS},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
149 title = {OrthoMCL: identification of ortholog groups for eukaryotic genomes},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
150 year = {2003},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
151 volume = {13},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
152 number = {9},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
153 pages = {2178-2189},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
154 </citation>
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
155 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
156 @article{Emms2015,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
157 journal = {Genome Biology}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
158 author = {5. Emms DM, Kelly S},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
159 title = {OrthoFinder: solving fundamental biases in whole genome comparisons dramatically improves orthogroup inference accuracy},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
160 year = {2015},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
161 volume = {16},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
162 number = {1},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
163 pages = {157},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
164 </citation>
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
165 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
166 @article{Stamatakis2014,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
167 journal = {Bioinformatics},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
168 author = {6. Stamatakis A},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
169 title = {RAxML Version 8: A tool for Phylogenetic Analysis and Post-Analysis of Large Phylogenies},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
170 year = {2014},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
171 url = {http://sco.h-its.org/exelixis/web/software/raxml/index.html},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
172 </citation>
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
173 <citation type="bibtex">
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
174 @article{Price2010,
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
175 journal = {PLoS one},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
176 author = {7. Price MN, Dehal PS, Arkin AP},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
177 title = {FastTree 2-approximately maximim-likelihood trees for large alignments},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
178 year = {2010},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
179 volume = {5},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
180 number = {3},
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
181 pages = {e9490},}
0e55cec5ec6b Uploaded
greg
parents: 4
diff changeset
182 </citation>
40
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
183 <citation type="bibtex">
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
184 @article{Nascimento2016,
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
185 journal = {Bioinformatics},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
186 author = {8. Nascimento M, Sousa A, Ramirez M, Francisco AP, CarriƧo JA, Vaz C},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
187 title = {PHYLOViZ 2.0: providing scalable data integration and visualization for multiple phylogenetic inference methods},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
188 year = {2016},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
189 volume = {33},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
190 number = {1},
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
191 pages = {128-129},}
67616a6037b3 Uploaded
greg
parents: 39
diff changeset
192 </citation>
0
f4361d941aa3 Uploaded
greg
parents:
diff changeset
193 </citations>
f4361d941aa3 Uploaded
greg
parents:
diff changeset
194 </tool>