annotate gene_family_classifier.xml @ 12:b75510484c16 draft

Uploaded
author greg
date Wed, 04 Jan 2017 13:52:09 -0500
parents b0a29067fc35
children cddbb2f13c28
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[
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
15 #set create_ortho_sequences = str($options_type.options_type_selector) == 'advanced' and str($options_type.create_orthogroup_cond.create_orthogroup) == 'yes'
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
16 #if create_ortho_sequences:
8
d678d4c2e9e1 Uploaded
greg
parents: 7
diff changeset
17 #import os
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
18 #set src_dir = $os.path.join('geneFamilyClassification_dir', 'orthogroups_fasta')
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 &&
4
2ffac03c08fe Uploaded
greg
parents: 3
diff changeset
21 #end if
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
22 GeneFamilyClassifier
315440c6fb44 Uploaded
greg
parents:
diff changeset
23 --proteins "$input"
315440c6fb44 Uploaded
greg
parents:
diff changeset
24 --scaffold "$scaffold"
315440c6fb44 Uploaded
greg
parents:
diff changeset
25 --method $method
315440c6fb44 Uploaded
greg
parents:
diff changeset
26 --classifier $classifier
315440c6fb44 Uploaded
greg
parents:
diff changeset
27 #if str($options_type.options_type_selector) == 'advanced':
315440c6fb44 Uploaded
greg
parents:
diff changeset
28 --super_orthogroups $options_type.super_orthogroups
315440c6fb44 Uploaded
greg
parents:
diff changeset
29 #if str($options_type.single_copy_cond) == 'taxa':
315440c6fb44 Uploaded
greg
parents:
diff changeset
30 --single_copy_taxa $options_type.single_copy_cond.single_copy_taxa
315440c6fb44 Uploaded
greg
parents:
diff changeset
31 --taxa_present $options_type.single_copy_cond.taxa_present
315440c6fb44 Uploaded
greg
parents:
diff changeset
32 #end if
3
a54b3161504f Uploaded
greg
parents: 2
diff changeset
33 #if str($options_type.create_orthogroup_cond.create_orthogroup) == 'yes':
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
34 --orthogroup_fasta
315440c6fb44 Uploaded
greg
parents:
diff changeset
35 --coding_sequences "$options_type.create_orthogroup_cond.coding_sequences"
315440c6fb44 Uploaded
greg
parents:
diff changeset
36 #end if
315440c6fb44 Uploaded
greg
parents:
diff changeset
37 #end if
2
5440f5f083bc Uploaded
greg
parents: 1
diff changeset
38 --scaffold_dir "${GALAXY_DATA_INDEX_DIR}/plant_tribes/scaffolds"
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
39 --num_threads \${GALAXY_SLOTS:-4}
12
b75510484c16 Uploaded
greg
parents: 11
diff changeset
40 #if str($classifier) == 'hmmscan' or str($classifier) == 'both':
b75510484c16 Uploaded
greg
parents: 11
diff changeset
41 # Eliminate the hmmscan.log file
b75510484c16 Uploaded
greg
parents: 11
diff changeset
42 && rm $src_dir/*.log
b75510484c16 Uploaded
greg
parents: 11
diff changeset
43 #end if
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
44 #if create_ortho_sequences:
12
b75510484c16 Uploaded
greg
parents: 11
diff changeset
45 && echo "Sequences classified into pre-computed orthologous plant gene family clusters: `ls $src_dir | wc -l` files" > $output
b75510484c16 Uploaded
greg
parents: 11
diff changeset
46 && mv $src_dir/* $dest_dir
4
2ffac03c08fe Uploaded
greg
parents: 3
diff changeset
47 #end if
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
48 ]]>
315440c6fb44 Uploaded
greg
parents:
diff changeset
49 </command>
315440c6fb44 Uploaded
greg
parents:
diff changeset
50 <inputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
51 <param name="input" format="fasta" type="data" label="Amino acids (proteins) sequences fasta file"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
52 <param name="scaffold" type="select" label="Orthogroups or gene families proteins scaffold">
315440c6fb44 Uploaded
greg
parents:
diff changeset
53 <options from_data_table="plant_tribes_scaffolds" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
54 <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
55 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
56 <param name="method" type="select" label="Protein clustering method">
315440c6fb44 Uploaded
greg
parents:
diff changeset
57 <option value="gfam" selected="true">GFam</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
58 <option value="orthofinder">OrthoFinder</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
59 <option value="orthomcl">OrthoMCL</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
60 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
61 <param name="classifier" type="select" label="Protein classification method">
315440c6fb44 Uploaded
greg
parents:
diff changeset
62 <option value="blastp" selected="true">blastp</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
63 <option value="hmmscan">HMMScan</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
64 <option value="both">Both blastp and HMMScan</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
65 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
66 <conditional name="options_type">
315440c6fb44 Uploaded
greg
parents:
diff changeset
67 <param name="options_type_selector" type="select" label="Options Configuration">
315440c6fb44 Uploaded
greg
parents:
diff changeset
68 <option value="basic" selected="true">Basic</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
69 <option value="advanced">Advanced</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
70 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
71 <when value="basic" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
72 <when value="advanced">
315440c6fb44 Uploaded
greg
parents:
diff changeset
73 <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
74 <option value="min_evalue" selected="true">Minimum e-value</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
75 <option value="avg_evalue">Average e-value</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
76 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
77 <conditional name="single_copy_cond">
315440c6fb44 Uploaded
greg
parents:
diff changeset
78 <param name="single_copy" type="select" label="Select single copy configuration">
315440c6fb44 Uploaded
greg
parents:
diff changeset
79 <option value="custom" selected="true">Single copy orthogroup custom</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
80 <option value="taxa">Minumum single copy taxa required in orthogroup</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
81 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
82 <when value="custom" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
83 <when value="taxa">
315440c6fb44 Uploaded
greg
parents:
diff changeset
84 <param name="single_copy_taxa" type="integer" value="20" label="Minumum single copy taxa required in orthogroup"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
85 <param name="taxa_present" type="integer" value="21" label="Minumum taxa required in single copy orthogroup"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
86 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
87 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
88 <conditional name="create_orthogroup_cond">
315440c6fb44 Uploaded
greg
parents:
diff changeset
89 <param name="create_orthogroup" type="select" label="Create orthogroup fasta files?">
315440c6fb44 Uploaded
greg
parents:
diff changeset
90 <option value="no" selected="true">No</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
91 <option value="yes">Yes</option>
315440c6fb44 Uploaded
greg
parents:
diff changeset
92 </param>
315440c6fb44 Uploaded
greg
parents:
diff changeset
93 <when value="no" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
94 <when value="yes">
315440c6fb44 Uploaded
greg
parents:
diff changeset
95 <param name="coding_sequences" format="fasta" type="data" label="Corresponding coding sequences (CDS) fasta file"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
96 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
97 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
98 </when>
315440c6fb44 Uploaded
greg
parents:
diff changeset
99 </conditional>
315440c6fb44 Uploaded
greg
parents:
diff changeset
100 </inputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
101 <outputs>
9
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
102 <data name="output" format="txt" label="Sequences classified into gene family clusters on ${on_string}">
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
103 <filter>options_type['options_type_selector'] == 'advanced' and options_type['create_orthogroup_cond']['create_orthogroup'] == 'yes'</filter>
c7010d37df2c Uploaded
greg
parents: 8
diff changeset
104 </data>
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
105 <collection name="transcripts" type="list">
12
b75510484c16 Uploaded
greg
parents: 11
diff changeset
106 <discover_datasets pattern="__name__" directory="geneFamilyClassification_dir" visible="false" ext="tabular" />
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
107 </collection>
315440c6fb44 Uploaded
greg
parents:
diff changeset
108 </outputs>
315440c6fb44 Uploaded
greg
parents:
diff changeset
109 <tests>
315440c6fb44 Uploaded
greg
parents:
diff changeset
110 <test>
315440c6fb44 Uploaded
greg
parents:
diff changeset
111 <param name="input" value="" ftype="fasta" />
315440c6fb44 Uploaded
greg
parents:
diff changeset
112 <param name="prediction_method" value="transdecoder"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
113 <param name="target_gene_family_assembly" value="no"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
114 <param name="strand_specific" value="yes"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
115 <param name="dereplicate" value="yes"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
116 <param name="min_length" value="200"/>
315440c6fb44 Uploaded
greg
parents:
diff changeset
117 <output_collection name="orthos" type="list">
315440c6fb44 Uploaded
greg
parents:
diff changeset
118
315440c6fb44 Uploaded
greg
parents:
diff changeset
119 </output_collection>
315440c6fb44 Uploaded
greg
parents:
diff changeset
120 </test>
315440c6fb44 Uploaded
greg
parents:
diff changeset
121 </tests>
315440c6fb44 Uploaded
greg
parents:
diff changeset
122 <help>
315440c6fb44 Uploaded
greg
parents:
diff changeset
123 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
124 complete protein sequences from sequenced plant genomes to perform comparative evolutionary studies. It performs gene family
0
315440c6fb44 Uploaded
greg
parents:
diff changeset
125 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
126 homologs) or both (more exhaustive).
315440c6fb44 Uploaded
greg
parents:
diff changeset
127
315440c6fb44 Uploaded
greg
parents:
diff changeset
128 -----
315440c6fb44 Uploaded
greg
parents:
diff changeset
129
315440c6fb44 Uploaded
greg
parents:
diff changeset
130 **Options**
315440c6fb44 Uploaded
greg
parents:
diff changeset
131
315440c6fb44 Uploaded
greg
parents:
diff changeset
132 * **Orthogroups or gene families proteins scaffold** - PlantTribes scaffolds data.
315440c6fb44 Uploaded
greg
parents:
diff changeset
133 * **Protein clustering method** - One of GFam, OrthoFinder or OrthoMCL.
315440c6fb44 Uploaded
greg
parents:
diff changeset
134 * **Protein classification method** - One of blastp, HMMScan or both.
315440c6fb44 Uploaded
greg
parents:
diff changeset
135 * **SuperOrthogroups MCL clustering** - blastp e-value matrix between all pairs of orthogroups.
315440c6fb44 Uploaded
greg
parents:
diff changeset
136 * **Minumum single copy taxa required in orthogroup** - Used with "Minumum single copy taxa required in orthogroup" configuration only.
315440c6fb44 Uploaded
greg
parents:
diff changeset
137 * **Minumum taxa required in single copy orthogroup** - Used with "Minumum single copy taxa required in orthogroup" configuration only.
315440c6fb44 Uploaded
greg
parents:
diff changeset
138 * **Corresponding coding sequences (CDS) fasta file** - Used only when selecting "Create orthogroup fasta files?".
315440c6fb44 Uploaded
greg
parents:
diff changeset
139
315440c6fb44 Uploaded
greg
parents:
diff changeset
140 </help>
315440c6fb44 Uploaded
greg
parents:
diff changeset
141 <citations>
315440c6fb44 Uploaded
greg
parents:
diff changeset
142 <citation type="bibtex">
315440c6fb44 Uploaded
greg
parents:
diff changeset
143 @unpublished{None,
315440c6fb44 Uploaded
greg
parents:
diff changeset
144 author = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
145 title = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
146 year = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
147 eprint = {None},
315440c6fb44 Uploaded
greg
parents:
diff changeset
148 url = {None}
315440c6fb44 Uploaded
greg
parents:
diff changeset
149 }</citation>
315440c6fb44 Uploaded
greg
parents:
diff changeset
150 </citations>
315440c6fb44 Uploaded
greg
parents:
diff changeset
151 </tool>