annotate gene_family_classifier.xml @ 16:1cf39b1af248 draft

Uploaded
author greg
date Thu, 05 Jan 2017 08:00:33 -0500
parents 9d4ec1102803
children cb7487bdab99
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8b5a8a3ca9ee Uploaded
greg
parents: 0
diff changeset
1 <tool id="plant_tribes_gene_family_classifier" name="GeneFamilyClassifier" version="1.0.0">
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
2 <description>pipeline</description>
315440c6fb44 Uploaded
greg
parents:
diff changeset
3 <requirements>
315440c6fb44 Uploaded
greg
parents:
diff changeset
4 <requirement type="package" version="0.2">plant_tribes_gene_family_classifier</requirement>
315440c6fb44 Uploaded
greg
parents:
diff changeset
5 </requirements>
315440c6fb44 Uploaded
greg
parents:
diff changeset
6 <stdio>
315440c6fb44 Uploaded
greg
parents:
diff changeset
7 <!-- Anything other than zero is an error -->
315440c6fb44 Uploaded
greg
parents:
diff changeset
8 <exit_code range="1:" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
9 <!-- In case the return code has not been set properly check stderr too -->
315440c6fb44 Uploaded
greg
parents:
diff changeset
10 <regex match="Error:" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
11 <regex match="Exception:" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
12 </stdio>
315440c6fb44 Uploaded
greg
parents:
diff changeset
13 <command>
315440c6fb44 Uploaded
greg
parents:
diff changeset
14 <![CDATA[
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
15 #if str($options_type.options_type_selector) == 'advanced' and str($options_type.create_orthogroup_cond.create_orthogroup) == 'yes':
8
d678d4c2e9e1 Uploaded
greg
parents: 7
diff changeset
16 #import os
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
17 #set create_ortho_sequences = True
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
18 #set orthogroups_fasta_src_dir = $os.path.join('geneFamilyClassification_dir', 'orthogroups_fasta')
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
19 #set dest_dir = $output.extra_files_path
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
20 mkdir -p $dest_dir &&
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
21 #else:
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
22 #set create_ortho_sequences = False
4
2ffac03c08fe Uploaded
greg
parents: 3
diff changeset
23 #end if
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
24 GeneFamilyClassifier
315440c6fb44 Uploaded
greg
parents:
diff changeset
25 --proteins "$input"
315440c6fb44 Uploaded
greg
parents:
diff changeset
26 --scaffold "$scaffold"
315440c6fb44 Uploaded
greg
parents:
diff changeset
27 --method $method
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
28 --classifier $save_hmmscan_log_cond.classifier
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
29 #if str($options_type.options_type_selector) == 'advanced':
315440c6fb44 Uploaded
greg
parents:
diff changeset
30 --super_orthogroups $options_type.super_orthogroups
315440c6fb44 Uploaded
greg
parents:
diff changeset
31 #if str($options_type.single_copy_cond) == 'taxa':
315440c6fb44 Uploaded
greg
parents:
diff changeset
32 --single_copy_taxa $options_type.single_copy_cond.single_copy_taxa
315440c6fb44 Uploaded
greg
parents:
diff changeset
33 --taxa_present $options_type.single_copy_cond.taxa_present
315440c6fb44 Uploaded
greg
parents:
diff changeset
34 #end if
3
a54b3161504f Uploaded
greg
parents: 2
diff changeset
35 #if str($options_type.create_orthogroup_cond.create_orthogroup) == 'yes':
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
36 --orthogroup_fasta
315440c6fb44 Uploaded
greg
parents:
diff changeset
37 --coding_sequences "$options_type.create_orthogroup_cond.coding_sequences"
315440c6fb44 Uploaded
greg
parents:
diff changeset
38 #end if
315440c6fb44 Uploaded
greg
parents:
diff changeset
39 #end if
2
5440f5f083bc Uploaded
greg
parents: 1
diff changeset
40 --scaffold_dir "${GALAXY_DATA_INDEX_DIR}/plant_tribes/scaffolds"
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
41 --num_threads \${GALAXY_SLOTS:-4}
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
42 #if str($save_hmmscan_log_cond.classifier) == 'hmmscan' or str($save_hmmscan_log_cond.classifier) == 'both':
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
43 #if str($save_hmmscan_log_cond.save_hmmscan_log) == 'yes':
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
44 && mv geneFamilyClassification_dir/hmmscan.log $hmmscan_log
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
45 #else:
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
46 && rm geneFamilyClassification_dir/hmmscan.log
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
47 #end if
12
b75510484c16 Uploaded
greg
parents: 11
diff changeset
48 #end if
14
595088cc480a Uploaded
greg
parents: 13
diff changeset
49 #if $create_ortho_sequences:
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
50 && echo "Sequences classified into pre-computed orthologous plant gene family clusters: `ls $orthogroups_fasta_src_dir | wc -l` files" > $output
16
1cf39b1af248 Uploaded
greg
parents: 15
diff changeset
51 && ls $orthogroups_fasta_src_dir >> $output
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
52 && mv $orthogroups_fasta_src_dir/* $dest_dir
4
2ffac03c08fe Uploaded
greg
parents: 3
diff changeset
53 #end if
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
54 ]]>
315440c6fb44 Uploaded
greg
parents:
diff changeset
55 </command>
315440c6fb44 Uploaded
greg
parents:
diff changeset
56 <inputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
57 <param name="input" format="fasta" type="data" label="Amino acids (proteins) sequences fasta file"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
58 <param name="scaffold" type="select" label="Orthogroups or gene families proteins scaffold">
315440c6fb44 Uploaded
greg
parents:
diff changeset
59 <options from_data_table="plant_tribes_scaffolds" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
60 <validator type="no_options" message="No PlantTribes scaffolds are available. Use the PlantTribes Scaffolds Download Data Manager tool to install and populate the PlantTribes scaffolds data table."/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
61 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
62 <param name="method" type="select" label="Protein clustering method">
315440c6fb44 Uploaded
greg
parents:
diff changeset
63 <option value="gfam" selected="true">GFam</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
64 <option value="orthofinder">OrthoFinder</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
65 <option value="orthomcl">OrthoMCL</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
66 </param>
13
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
67 <conditional name="save_hmmscan_log_cond">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
68 <param name="classifier" type="select" label="Protein classification method">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
69 <option value="blastp" selected="true">blastp</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
70 <option value="hmmscan">HMMScan</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
71 <option value="both">Both blastp and HMMScan</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
72 </param>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
73 <when value="blastp" />
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
74 <when value="hmmscan">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
75 <param name="save_hmmscan_log" type="select" label="Save hmmscan log?" help="Save the hmmscan log in an additional output dataset">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
76 <option value="no" selected="true">No</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
77 <option value="yes">Yes</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
78 </param>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
79 </when>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
80 <when value="both">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
81 <param name="save_hmmscan_log" type="select" label="Save hmmscan log?" help="Save the hmmscan log in an additional output dataset">
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
82 <option value="no" selected="true">No</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
83 <option value="yes">Yes</option>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
84 </param>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
85 </when>
cddbb2f13c28 Uploaded
greg
parents: 12
diff changeset
86 </conditional>
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
87 <conditional name="options_type">
315440c6fb44 Uploaded
greg
parents:
diff changeset
88 <param name="options_type_selector" type="select" label="Options Configuration">
315440c6fb44 Uploaded
greg
parents:
diff changeset
89 <option value="basic" selected="true">Basic</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
90 <option value="advanced">Advanced</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
91 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
92 <when value="basic" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
93 <when value="advanced">
315440c6fb44 Uploaded
greg
parents:
diff changeset
94 <param name="super_orthogroups" type="select" label="SuperOrthogroups MCL clustering" help="blastp e-value matrix between all pairs of orthogroups">
315440c6fb44 Uploaded
greg
parents:
diff changeset
95 <option value="min_evalue" selected="true">Minimum e-value</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
96 <option value="avg_evalue">Average e-value</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
97 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
98 <conditional name="single_copy_cond">
315440c6fb44 Uploaded
greg
parents:
diff changeset
99 <param name="single_copy" type="select" label="Select single copy configuration">
315440c6fb44 Uploaded
greg
parents:
diff changeset
100 <option value="custom" selected="true">Single copy orthogroup custom</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
101 <option value="taxa">Minumum single copy taxa required in orthogroup</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
102 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
103 <when value="custom" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
104 <when value="taxa">
315440c6fb44 Uploaded
greg
parents:
diff changeset
105 <param name="single_copy_taxa" type="integer" value="20" label="Minumum single copy taxa required in orthogroup"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
106 <param name="taxa_present" type="integer" value="21" label="Minumum taxa required in single copy orthogroup"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
107 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
108 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
109 <conditional name="create_orthogroup_cond">
315440c6fb44 Uploaded
greg
parents:
diff changeset
110 <param name="create_orthogroup" type="select" label="Create orthogroup fasta files?">
315440c6fb44 Uploaded
greg
parents:
diff changeset
111 <option value="no" selected="true">No</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
112 <option value="yes">Yes</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
113 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
114 <when value="no" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
115 <when value="yes">
315440c6fb44 Uploaded
greg
parents:
diff changeset
116 <param name="coding_sequences" format="fasta" type="data" label="Corresponding coding sequences (CDS) fasta file"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
117 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
118 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
119 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
120 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
121 </inputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
122 <outputs>
15
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
123 <data name="hmmscan_log" format="txt" label="Protein classification hmmscan.log on ${on_string}">
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
124 <filter>save_hmmscan_log_cond['classifier'] in ['hmmscan', 'both'] and save_hmmscan_log_cond['save_hmmscan_log'] == 'yes'</filter>
9d4ec1102803 Uploaded
greg
parents: 14
diff changeset
125 </data>
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
126 <data name="output" format="txt" label="Sequences classified into gene family clusters on ${on_string}">
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
127 <filter>options_type['options_type_selector'] == 'advanced' and options_type['create_orthogroup_cond']['create_orthogroup'] == 'yes'</filter>
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
128 </data>
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
129 <collection name="transcripts" type="list">
12
b75510484c16 Uploaded
greg
parents: 11
diff changeset
130 <discover_datasets pattern="__name__" directory="geneFamilyClassification_dir" visible="false" ext="tabular" />
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
131 </collection>
315440c6fb44 Uploaded
greg
parents:
diff changeset
132 </outputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
133 <tests>
315440c6fb44 Uploaded
greg
parents:
diff changeset
134 <test>
315440c6fb44 Uploaded
greg
parents:
diff changeset
135 <param name="input" value="" ftype="fasta" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
136 <param name="prediction_method" value="transdecoder"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
137 <param name="target_gene_family_assembly" value="no"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
138 <param name="strand_specific" value="yes"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
139 <param name="dereplicate" value="yes"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
140 <param name="min_length" value="200"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
141 <output_collection name="orthos" type="list">
315440c6fb44 Uploaded
greg
parents:
diff changeset
142
315440c6fb44 Uploaded
greg
parents:
diff changeset
143 </output_collection>
315440c6fb44 Uploaded
greg
parents:
diff changeset
144 </test>
315440c6fb44 Uploaded
greg
parents:
diff changeset
145 </tests>
315440c6fb44 Uploaded
greg
parents:
diff changeset
146 <help>
315440c6fb44 Uploaded
greg
parents:
diff changeset
147 This tool is one of the PlantTribes' collection of automated modular analysis pipelines that utilize objective classifications of
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
148 complete protein sequences from sequenced plant genomes to perform comparative evolutionary studies. It performs gene family
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
149 classification of the post processed de novo transcripts using either blastp (faster), HMMScan (slower but more sensitive to remote
315440c6fb44 Uploaded
greg
parents:
diff changeset
150 homologs) or both (more exhaustive).
315440c6fb44 Uploaded
greg
parents:
diff changeset
151
315440c6fb44 Uploaded
greg
parents:
diff changeset
152 -----
315440c6fb44 Uploaded
greg
parents:
diff changeset
153
315440c6fb44 Uploaded
greg
parents:
diff changeset
154 **Options**
315440c6fb44 Uploaded
greg
parents:
diff changeset
155
315440c6fb44 Uploaded
greg
parents:
diff changeset
156 * **Orthogroups or gene families proteins scaffold** - PlantTribes scaffolds data.
315440c6fb44 Uploaded
greg
parents:
diff changeset
157 * **Protein clustering method** - One of GFam, OrthoFinder or OrthoMCL.
315440c6fb44 Uploaded
greg
parents:
diff changeset
158 * **Protein classification method** - One of blastp, HMMScan or both.
315440c6fb44 Uploaded
greg
parents:
diff changeset
159 * **SuperOrthogroups MCL clustering** - blastp e-value matrix between all pairs of orthogroups.
315440c6fb44 Uploaded
greg
parents:
diff changeset
160 * **Minumum single copy taxa required in orthogroup** - Used with "Minumum single copy taxa required in orthogroup" configuration only.
315440c6fb44 Uploaded
greg
parents:
diff changeset
161 * **Minumum taxa required in single copy orthogroup** - Used with "Minumum single copy taxa required in orthogroup" configuration only.
315440c6fb44 Uploaded
greg
parents:
diff changeset
162 * **Corresponding coding sequences (CDS) fasta file** - Used only when selecting "Create orthogroup fasta files?".
315440c6fb44 Uploaded
greg
parents:
diff changeset
163
315440c6fb44 Uploaded
greg
parents:
diff changeset
164 </help>
315440c6fb44 Uploaded
greg
parents:
diff changeset
165 <citations>
315440c6fb44 Uploaded
greg
parents:
diff changeset
166 <citation type="bibtex">
315440c6fb44 Uploaded
greg
parents:
diff changeset
167 @unpublished{None,
315440c6fb44 Uploaded
greg
parents:
diff changeset
168 author = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
169 title = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
170 year = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
171 eprint = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
172 url = {None}
315440c6fb44 Uploaded
greg
parents:
diff changeset
173 }</citation>
315440c6fb44 Uploaded
greg
parents:
diff changeset
174 </citations>
315440c6fb44 Uploaded
greg
parents:
diff changeset
175 </tool>