annotate gene_family_phylogeny_builder.xml @ 61:d53837d5dc99 draft

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