annotate gene_family_aligner.xml @ 13:d7e6201b8d81 draft

Uploaded
author greg
date Mon, 10 Apr 2017 14:46:51 -0400
parents 19529df59e9d
children af8dad310c32
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
badd2d0f1689 Uploaded
greg
parents: 5
diff changeset
1 <tool id="plant_tribes_gene_family_aligner" name="GeneFamilyAligner" version="@WRAPPER_VERSION@.0">
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
2 <description>aligns gene family sequences</description>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
3 <macros>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
4 <import>macros.xml</import>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
5 </macros>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
6 <expand macro="requirements_gene_family_aligner" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
7 <expand macro="stdio" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
8 <command>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
9 <![CDATA[
6accbd3a1449 Uploaded
greg
parents:
diff changeset
10 #set input_format = $input_format_cond.input_format
6accbd3a1449 Uploaded
greg
parents:
diff changeset
11 #set alignment_method_cond = $input_format_cond.alignment_method_cond
6accbd3a1449 Uploaded
greg
parents:
diff changeset
12 #set alignment_method = $alignment_method_cond.alignment_method
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
13 #if str($input_format_cond.input_format) == 'ptortho':
13
d7e6201b8d81 Uploaded
greg
parents: 12
diff changeset
14 #set output_codon_alignments = False
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
15 #else if str($input_format_cond.input_format) == 'ptorthocs' and str($input_format_cond.codon_alignments ) == 'no':
13
d7e6201b8d81 Uploaded
greg
parents: 12
diff changeset
16 #set output_codon_alignments = False
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
17 #else:
13
d7e6201b8d81 Uploaded
greg
parents: 12
diff changeset
18 #set output_codon_alignments = True
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
19 #end if
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
20
6accbd3a1449 Uploaded
greg
parents:
diff changeset
21 python $__tool_directory__/gene_family_aligner.py
6accbd3a1449 Uploaded
greg
parents:
diff changeset
22 --alignment_method $alignment_method
6accbd3a1449 Uploaded
greg
parents:
diff changeset
23 #if str($alignment_method) == 'pasta':
6accbd3a1449 Uploaded
greg
parents:
diff changeset
24 --pasta_script_path '$__tool_directory__/run_pasta.py'
6accbd3a1449 Uploaded
greg
parents:
diff changeset
25 --pasta_iter_limit $alignment_method_cond.pasta_iter_limit
6accbd3a1449 Uploaded
greg
parents:
diff changeset
26 #end if
6accbd3a1449 Uploaded
greg
parents:
diff changeset
27 --num_threads \${GALAXY_SLOTS:-4}
6accbd3a1449 Uploaded
greg
parents:
diff changeset
28 #if str($input_format) == 'ptortho':
6accbd3a1449 Uploaded
greg
parents:
diff changeset
29 --orthogroup_faa '$input_format_cond.input_ptortho.extra_files_path'
6accbd3a1449 Uploaded
greg
parents:
diff changeset
30 #else:
6accbd3a1449 Uploaded
greg
parents:
diff changeset
31 ## str($input_format) == 'ptorthocs'
6accbd3a1449 Uploaded
greg
parents:
diff changeset
32 --orthogroup_faa '$input_format_cond.input_ptorthocs.extra_files_path'
6accbd3a1449 Uploaded
greg
parents:
diff changeset
33 #if str($input_format_cond.codon_alignments) == 'yes':
6accbd3a1449 Uploaded
greg
parents:
diff changeset
34 --codon_alignments 'true'
6accbd3a1449 Uploaded
greg
parents:
diff changeset
35 #end if
6accbd3a1449 Uploaded
greg
parents:
diff changeset
36 #end if
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
37 #set remove_gappy_sequences = $remove_gappy_sequences_cond.remove_gappy_sequences
19529df59e9d Uploaded
greg
parents: 10
diff changeset
38 #if str($remove_gappy_sequences) == 'yes':
19529df59e9d Uploaded
greg
parents: 10
diff changeset
39 #set trim_type_cond = $remove_gappy_sequences_cond.trim_type_cond
19529df59e9d Uploaded
greg
parents: 10
diff changeset
40 #set trim_type = $trim_type_cond.trim_type
19529df59e9d Uploaded
greg
parents: 10
diff changeset
41 #if str($trim_type) == 'gap_trimming':
19529df59e9d Uploaded
greg
parents: 10
diff changeset
42 --gap_trimming $trim_type_cond.gap_trimming
19529df59e9d Uploaded
greg
parents: 10
diff changeset
43 #else:
19529df59e9d Uploaded
greg
parents: 10
diff changeset
44 ## str($trim_type) == 'automated_trimming'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
45 --automated_trimming 'true'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
46 #end if
19529df59e9d Uploaded
greg
parents: 10
diff changeset
47 #set remove_sequences_with_gaps_cond = $remove_gappy_sequences_cond.remove_sequences_with_gaps_cond
19529df59e9d Uploaded
greg
parents: 10
diff changeset
48 #set remove_sequences_with_gaps = $remove_sequences_with_gaps_cond.remove_sequences_with_gaps
19529df59e9d Uploaded
greg
parents: 10
diff changeset
49 #if str($remove_sequences_with_gaps) == 'yes':
19529df59e9d Uploaded
greg
parents: 10
diff changeset
50 --remove_sequences $remove_sequences_with_gaps_cond.remove_sequences_with_gaps_of
19529df59e9d Uploaded
greg
parents: 10
diff changeset
51 --iterative_realignment $remove_sequences_with_gaps_cond.iterative_realignment
19529df59e9d Uploaded
greg
parents: 10
diff changeset
52 #if $output_codon_alignments:
19529df59e9d Uploaded
greg
parents: 10
diff changeset
53 --output '$output_aln_filtered_ca'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
54 --output_dir '$output_aln_filtered_ca.files_path'
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
55 #else:
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
56 --output '$output_aln_filtered'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
57 --output_dir '$output_aln_filtered.files_path'
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
58 #end if
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
59 #else:
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
60 #if $output_codon_alignments:
19529df59e9d Uploaded
greg
parents: 10
diff changeset
61 --output '$output_aln_trimmed_ca'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
62 --output_dir '$output_aln_trimmed_ca.files_path'
10
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
63 #else:
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
64 --output '$output_aln_trimmed'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
65 --output_dir '$output_aln_trimmed.files_path'
10
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
66 #end if
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
67 #end if
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
68 #else:
19529df59e9d Uploaded
greg
parents: 10
diff changeset
69 #if $output_codon_alignments:
19529df59e9d Uploaded
greg
parents: 10
diff changeset
70 --output '$output_aln_ca'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
71 --output_dir '$output_aln_ca.files_path'
19529df59e9d Uploaded
greg
parents: 10
diff changeset
72 #else:
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
73 --output '$output_aln'
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
74 --output_dir '$output_aln.files_path'
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
75 #end if
6accbd3a1449 Uploaded
greg
parents:
diff changeset
76 #end if
6accbd3a1449 Uploaded
greg
parents:
diff changeset
77 ]]>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
78 </command>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
79 <inputs>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
80 <conditional name="input_format_cond">
6accbd3a1449 Uploaded
greg
parents:
diff changeset
81 <param name="input_format" type="select" label="Select type of data to sub sample">
6accbd3a1449 Uploaded
greg
parents:
diff changeset
82 <option value="ptortho">Gene family clusters</option>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
83 <option value="ptorthocs">Gene family clusters with corresponding coding sequences</option>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
84 </param>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
85 <when value="ptortho">
6accbd3a1449 Uploaded
greg
parents:
diff changeset
86 <param name="input_ptortho" format="ptortho" type="data" label="Gene family clusters" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
87 <expand macro="cond_alignment_method" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
88 </when>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
89 <when value="ptorthocs">
6accbd3a1449 Uploaded
greg
parents:
diff changeset
90 <param name="input_ptorthocs" format="ptorthocs" type="data" label="Gene family clusters with corresponding coding sequences" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
91 <expand macro="cond_alignment_method" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
92 <expand macro="param_codon_alignments" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
93 </when>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
94 </conditional>
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
95 <expand macro="cond_remove_gappy_sequences" />
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
96 </inputs>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
97 <outputs>
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
98 <data name="output_aln" format="ptalign" label="Aligned gene family sequences on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
99 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and remove_gappy_sequences_cond['remove_gappy_sequences'] == 'no'</filter>
10
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
100 </data>
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
101 <data name="output_aln_ca" format="ptalignca" label="Aligned gene family sequences with codon alignments on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
102 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and remove_gappy_sequences_cond['remove_gappy_sequences'] == 'no'</filter>
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
103 </data>
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
104 <data name="output_aln_filtered" format="ptalignfiltered" label="Filtered aligned gene family sequences on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
105 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'yes')</filter>
10
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
106 </data>
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
107 <data name="output_aln_filtered_ca" format="ptalignfilteredca" label="Filtered aligned gene family sequences with codon alignments on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
108 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'yes')</filter>
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
109 </data>
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
110 <data name="output_aln_trimmed" format="ptaligntrimmed" label="Trimmed aligned gene family sequences on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
111 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'no')</filter>
10
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
112 </data>
5ad5d4204edf Uploaded
greg
parents: 9
diff changeset
113 <data name="output_aln_trimmed_ca" format="ptaligntrimmedca" label="Trimmed aligned gene family sequences with codon alignments on ${on_string}">
12
19529df59e9d Uploaded
greg
parents: 10
diff changeset
114 <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'no')</filter>
8
9e68bebb3d7c Uploaded
greg
parents: 6
diff changeset
115 </data>
0
6accbd3a1449 Uploaded
greg
parents:
diff changeset
116 </outputs>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
117 <tests>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
118 <!-- Test framework does not currently support inputs whose associated files_path contains files to be analyzed.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
119 <test>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
120 </test>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
121 -->
6accbd3a1449 Uploaded
greg
parents:
diff changeset
122 </tests>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
123 <help>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
124 This tool is one of the PlantTribes collection of automated modular analysis pipelines for comparative and evolutionary
6accbd3a1449 Uploaded
greg
parents:
diff changeset
125 analyses of genome-scale gene families and transcriptomes. This tool aligns gene family sequences.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
126
6accbd3a1449 Uploaded
greg
parents:
diff changeset
127 -----
6accbd3a1449 Uploaded
greg
parents:
diff changeset
128
6accbd3a1449 Uploaded
greg
parents:
diff changeset
129 **Required options**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
130
6accbd3a1449 Uploaded
greg
parents:
diff changeset
131 * **Select type of data to sub sample**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
132
6accbd3a1449 Uploaded
greg
parents:
diff changeset
133 - **Gene family clusters** - sequences classified into gene family clusters.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
134 - **Gene family clusters with corresponding coding sequences** - sequences classified into gene family clusters including corresponding coding sequences.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
135
6accbd3a1449 Uploaded
greg
parents:
diff changeset
136 - **Construct orthogroup multiple codon alignments** - construct orthogroup multiple codon alignments.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
137
6accbd3a1449 Uploaded
greg
parents:
diff changeset
138 * **Select method for multiple sequence alignments**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
139
6accbd3a1449 Uploaded
greg
parents:
diff changeset
140 - **MAFFT algorithm** - mafft algorithm.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
141 - **Pasta algorithm** - pasta algorithm.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
142
6accbd3a1449 Uploaded
greg
parents:
diff changeset
143 - **Maximum number of iterations that the PASTA algorithm will execute** - maximum number of iterations that the PASTA algorithm will execute.
6accbd3a1449 Uploaded
greg
parents:
diff changeset
144
6accbd3a1449 Uploaded
greg
parents:
diff changeset
145 **Other options**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
146
6accbd3a1449 Uploaded
greg
parents:
diff changeset
147 * **Remove gappy sequences in alignments**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
148
6accbd3a1449 Uploaded
greg
parents:
diff changeset
149 - **Select process used for gap trimming** - either nucleotide based or using trimAl's ML heuristic trimming approach
6accbd3a1449 Uploaded
greg
parents:
diff changeset
150
6accbd3a1449 Uploaded
greg
parents:
diff changeset
151 - **Nucleotide based**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
152
6accbd3a1449 Uploaded
greg
parents:
diff changeset
153 - **Remove sites in alignments with gaps of**
6accbd3a1449 Uploaded
greg
parents:
diff changeset
154 - **Maximum number of iterations** - maximum number of iterations for iterative orthogroups realignment, trimming and fitering
6accbd3a1449 Uploaded
greg
parents:
diff changeset
155
6accbd3a1449 Uploaded
greg
parents:
diff changeset
156 </help>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
157 <citations>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
158 <expand macro="citation1" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
159 <expand macro="citations2to4" />
6accbd3a1449 Uploaded
greg
parents:
diff changeset
160 </citations>
6accbd3a1449 Uploaded
greg
parents:
diff changeset
161 </tool>