annotate kaks_analysis.xml @ 3:bbc153dbaee7 draft

Uploaded
author greg
date Wed, 01 Mar 2017 11:13:06 -0500
parents db3e35944c09
children 7fc692c81c02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
431e4f3487a7 Uploaded
greg
parents: 0
diff changeset
1 <tool id="plant_tribes_kaks_analysis" name="Perform orthologous or paralogous ks analyses" version="0.7.0">
431e4f3487a7 Uploaded
greg
parents: 0
diff changeset
2 <description>of coding sequences and amino acid sequences</description>
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
3 <requirements>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
4 <requirement type="package" version="0.7">plant_tribes_kaks_analysis</requirement>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
5 </requirements>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
6 <stdio>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
7 <!-- Anything other than zero is an error -->
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
8 <exit_code range="1:" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
9 <exit_code range=":-1" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
10 <!-- In case the return code has not been set propery check stderr too -->
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
11 <regex match="Error:" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
12 <regex match="Exception:" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
13 </stdio>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
14 <command>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
15 <![CDATA[
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
16 #if str($options_type.options_type_selector) == 'advanced':
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
17 #set codeml_ctl_file_cond = $options_type.codeml_ctl_file_cond
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
18 #set codeml_ctl_file_select = $codeml_ctl_file_cond.codeml_ctl_file_select
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
19 #set fit_components_cond = $options_type.fit_components_cond
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
20 #set fit_components = $fit_components_cond.fit_components
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
21 #end if
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
22 KaKsAnalysis
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
23 --config_dir '$scaffold.fields.path'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
24 --num_threads \${GALAXY_SLOTS:-4}
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
25 --coding_sequences_species_1 '$coding_sequences_species_1'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
26 --proteins_species_1 '$proteins_species_1'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
27 --comparison $comparison
3
bbc153dbaee7 Uploaded
greg
parents: 2
diff changeset
28 #if str($comparison_cond.comparison) == 'orthologs':
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
29 --coding_sequences_species_2 '$comparison_cond.coding_sequences_species_2'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
30 --proteins_species_2 '$comparison_cond.proteins_species_2'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
31 #end if
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
32 #if str($options_type.options_type_selector) == 'advanced':
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
33 --min_coverage $min_coverage
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
34 --recalibration_rate $recalibration_rate
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
35 #if str($codeml_ctl_file_select) == 'yes':
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
36 --codeml_ctl_file '$codeml_ctl_file_cond.codeml_ctl_file'
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
37 # No else block needed here because the default codeml_ctl config
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
38 # will be used if the --codeml_ctl_file flag is missing.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
39 #end if
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
40 #if str($fit_components) == 'yes':
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
41 --num_of_components $fit_components_cond.num_of_components
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
42 --min_ks $fit_components_cond.min_ks
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
43 --max_ks $fit_components_cond.max_ks
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
44 #end if
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
45 #end if
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
46 ]]>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
47 </command>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
48 <inputs>
2
db3e35944c09 Uploaded
greg
parents: 1
diff changeset
49 <param name="scaffold" type="select" label="Orthogroups or gene families proteins scaffold">
db3e35944c09 Uploaded
greg
parents: 1
diff changeset
50 <options from_data_table="plant_tribes_scaffolds" />
db3e35944c09 Uploaded
greg
parents: 1
diff changeset
51 <validator type="no_options" message="No PlantTribes scaffolds are available. Use the PlantTribes Scaffolds Download Data Manager tool in Galaxy to install and populate the PlantTribes scaffolds data table."/>
db3e35944c09 Uploaded
greg
parents: 1
diff changeset
52 </param>
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
53 <param name="coding_sequences_species_1" format="fasta" type="data" label="Coding sequences (CDS) fasta file for the species" />
3
bbc153dbaee7 Uploaded
greg
parents: 2
diff changeset
54 <param name="proteins_species_1" format="fasta" type="data" label="Aamino acids (proteins) sequences fasta file for the species" />
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
55 <conditional name="comparison_cond">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
56 <param name="comparison" type="select" label="Select method for pairwise sequence comparison to determine homolgous pairs" help="Cross species comparison requires selection of inputs for second species">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
57 <option value="paralogs" selected="true">Self species comparison</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
58 <option value="orthologs">Cross species comparison</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
59 </param>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
60 <when value="paralogs" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
61 <when value="orthologs">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
62 <param name="coding_sequences_species_2" format="fasta" type="data" label="Coding sequences (CDS) fasta file for the second species" />
3
bbc153dbaee7 Uploaded
greg
parents: 2
diff changeset
63 <param name="proteins_species_2" format="fasta" type="data" label="Aamino acids (proteins) sequences fasta file for the second species" />
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
64 </when>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
65 </conditional>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
66 <conditional name="options_type">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
67 <param name="options_type_selector" type="select" label="Options Configuration">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
68 <option value="basic" selected="true">Basic</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
69 <option value="advanced">Advanced</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
70 </param>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
71 <when value="basic" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
72 <when value="advanced">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
73 <param name="min_coverage" type="float" value="0.5" min="0.3" max="1.0" label="Minimum sequence pairwise coverage length between homologous pairs" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
74 <param name="recalibration_rate" type="float" value="0.0" min="0.0" label="Predetermined evolutionary rate for recalibrating synonymous subsitutions (ks) of species" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
75 <conditional name="codeml_ctl_file_cond">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
76 <param name="codeml_ctl_file_select" type="select" label="Select PAML codeml control file?" help="Used for ML analysis of protein-coding DNA sequences using codon substitution models, select No to use the default control file">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
77 <option value="no" selected="true">No</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
78 <option value="yes">Yes</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
79 </param>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
80 <when value="no" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
81 <when value="yes">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
82 <param name="codeml_ctl_file" format="txt" type="data" label="PAML codeml control file" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
83 </when>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
84 </conditional>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
85 <conditional name="fit_components_cond">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
86 <param name="fit_components" type="select" label="Fit a mixture model of multivariate normal components to synonymous (ks) distribution?" help="Used to identify significant duplication events in a genome">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
87 <option value="no" selected="true">No</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
88 <option value="yes">Yes</option>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
89 </param>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
90 <when value="no" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
91 <when value="yes">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
92 <param name="num_of_components" type="integer" value="0" min="0" label="Number components to fit to synonymous subsitutions (ks) distribution" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
93 <param name="min_ks" type="float" value="0.0" min="0.0" label="Lower limit of synonymous subsitutions (ks)" help="Reduces background noise from young paralogous pairs due to normal gene births and deaths in a genome" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
94 <param name="max_ks" type="float" value="0.0" min="0.0" label="Upper limit of synonymous subsitutions (ks)" help="Excludes likey ancient paralogous pairs" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
95 </when>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
96 </conditional>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
97 </when>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
98 </conditional>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
99 </inputs>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
100 <outputs>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
101 <collection name="ks_files" type="list">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
102 <discover_datasets pattern="__name__" directory="kaksAnalysis_dir" visible="false" ext="fasta" />
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
103 </collection>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
104 </outputs>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
105 <tests>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
106 <test>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
107 </test>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
108 </tests>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
109 <help>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
110 This tool is one of the PlantTribes' collection of automated modular analysis pipelines that utilize objective classifications of
1
431e4f3487a7 Uploaded
greg
parents: 0
diff changeset
111 complete protein sequences from sequenced plant genomes to perform comparative evolutionary studies. This tool performs orthologous
431e4f3487a7 Uploaded
greg
parents: 0
diff changeset
112 or paralogous ks analyses of coding sequences and amino acid sequences.
0
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
113
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
114 -----
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
115
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
116 **Options**
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
117
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
118 * **Required options**
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
119
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
120 - **Select gene family clusters** - Sequences classified into gene family clusters, optionally including corresponding coding sequences.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
121 - **Orthogroups or gene families proteins scaffold** - PlantTribes scaffolds data.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
122 - **Protein clustering method** - One of GFam (domain architecture based clustering), OrthoFinder (broadly defined clusters) or OrthoMCL (narrowly defined clusters).
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
123
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
124 * **Multiple sequence alignments options**
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
125
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
126 - **Select method for multiple sequence alignments** - Method used for setting multiple sequence alignments.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
127 - **Input sequences include corresponding coding sequences?** - Selecting 'Yes' for this option requires that the selected input data format is 'ptorthocs'.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
128 - **Construct orthogroup multiple codon alignments?** - Construct orthogroup multiple codon alignments.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
129 - **Sequence type used in the phylogenetic inference** - Sequence type (dna or amino acid) used in the phylogenetic inference.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
130 - **Use corresponding coding sequences?** - Selecting 'Yes' for this option requires that the selected input data format is 'ptorthocs' or this tool will produce an error.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
131
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
132 * **Phylogenetic trees options**
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
133
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
134 - **Phylogenetic trees inference method** - Phylogenetic trees inference method.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
135 - **Select rooting order configuration for rooting trees??** - If 'No' is selected, trees will be rooted using the most distant taxon present in the orthogroup.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
136 - **Number of replicates for rapid bootstrap analysis and search for the best-scoring ML tree** - Number of replicates for rapid bootstrap analysis and search for the best-scoring ML tree.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
137 - **Maximum number of sequences in orthogroup alignments** - Maximum number of sequences in orthogroup alignments.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
138 - **Minimum number of sequences in orthogroup alignments** - Minimum number of sequences in orthogroup alignments.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
139
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
140 * **MSA quality control options**
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
141
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
142 - **Remove sequences with gaps of** - Removes gappy sequences in alignments (i.e., 0.5 removes sequences with 50% gaps).
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
143 - **Select process used for gap trimming** - Either nucleotide based trimming or alignments are trimed using using trimAl's ML heuristic trimming approach.
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
144 - **Remove sites in alignments with gaps of** - If the process used for gap trimming is nucleotide based, this is the gap value used when removing gappy sites in alignments (i.e., 0.1 removes sites with 90% gaps).
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
145
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
146 </help>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
147 <citations>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
148 <citation type="bibtex">
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
149 @unpublished{None,
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
150 author = {Eric Wafula},
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
151 title = {None},
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
152 year = {None},
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
153 url = {https://github.com/dePamphilis/PlantTribes}
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
154 }
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
155 </citation>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
156 <citation type="doi">10.1186/1471-2105-10-421</citation>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
157 <citation type="doi">10.1093/molbev/msm088</citation>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
158 <citation type="doi">10.18637/jss.v004.i02</citation>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
159 </citations>
ef6cd36613a8 Uploaded
greg
parents:
diff changeset
160 </tool>