annotate tools/effectiveT3/effectiveT3.xml @ 14:1e681e19e35c draft

Uploaded v0.0.12c, development moved to GitHub
author peterjc
date Tue, 17 Sep 2013 11:44:41 -0400
parents 169f8af5dd80
children 17fbf8b8a554
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
392279f2e120 Uploaded v0.0.12, more explicit output name
peterjc
parents: 4
diff changeset
1 <tool id="effectiveT3" name="Effective T3" version="0.0.12">
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
2 <description>Find bacterial effectors in protein sequences</description>
3
a321504ba2c0 Uploaded v0.0.11 take 2, explicit package requirement
peterjc
parents: 2
diff changeset
3 <requirements>
a321504ba2c0 Uploaded v0.0.11 take 2, explicit package requirement
peterjc
parents: 2
diff changeset
4 <requirement type="package" version="1.0.1">effectiveT3</requirement>
a321504ba2c0 Uploaded v0.0.11 take 2, explicit package requirement
peterjc
parents: 2
diff changeset
5 </requirements>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
6 <version_command interpreter="python">effectiveT3.py --version</version_command>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
7 <command interpreter="python">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
8 effectiveT3.py $module.fields.path
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
9 #if $restrict.type=="cutoff":
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
10 cutoff=$restrict.cutoff
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
11 #else:
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
12 $restrict.type
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
13 #end if
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
14 $fasta_file $tabular_file</command>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
15 <stdio>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
16 <!-- Anything other than zero is an error -->
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
17 <exit_code range="1:" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
18 <exit_code range=":-1" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
19 </stdio>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
20 <inputs>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
21 <param name="fasta_file" type="data" format="fasta" label="FASTA file of protein sequences"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
22 <param name="module" type="select" display="radio" label="Classification module">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
23 <options from_file="effectiveT3.loc">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
24 <column name="value" index="0"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
25 <column name="name" index="1"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
26 <column name="path" index="2"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
27 </options>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
28 </param>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
29 <conditional name="restrict">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
30 <param name="type" type="select" label="Cut-off setting">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
31 <option value="selective">Selective (threshold set in module)</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
32 <option value="sensitive">Sensitive (threshold set in module)</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
33 <option value="cutoff">User defined cut-off</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
34 </param>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
35 <when value="selective" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
36 <when value="sensitive" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
37 <when value="cutoff" >
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
38 <param name="cutoff" type="float" min="0" max="1" label="Cut-off" value="" help="Threshold cut-off between 0 and 1" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
39 </when>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
40 </conditional>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
41 </inputs>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
42 <outputs>
11
392279f2e120 Uploaded v0.0.12, more explicit output name
peterjc
parents: 4
diff changeset
43 <data name="tabular_file" format="tabular" label="Effective T3 $module.value_label on ${on_string}" />
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
44 </outputs>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
45 <tests>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
46 <test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
47 <param name="fasta_file" value="four_human_proteins.fasta" ftype="fasta" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
48 <param name="module" value="animal" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
49 <param name="type" value="selective" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
50 <output name="tabular_file" file="four_human_proteins.effectiveT3.tabular" ftype="tabular" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
51 </test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
52 <test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
53 <param name="fasta_file" value="empty.fasta" ftype="fasta" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
54 <param name="module" value="plant" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
55 <param name="type" value="sensistive" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
56 <output name="tabular_file" file="empty_effectiveT3.tabular" ftype="tabular" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
57 </test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
58 </tests>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
59 <help>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
60
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
61 **What it does**
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
62
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
63 This calls the command line Effective T3 v1.0.1 tool for prediction of bacterial effector proteins.
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
64
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
65 The input is a FASTA file of protein sequences, and the output is tabular with four columns (one row per protein):
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
66
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
67 ====== ==============================================================================
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
68 Column Description
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
69 ------ ------------------------------------------------------------------------------
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
70 1 Sequence identifier
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
71 2 Sequence description (from the FASTA file)
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
72 3 Score (between 0 and 1, or negative for an error such as a very short peptide)
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
73 4 Predicted effector (true/false)
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
74 ====== ==============================================================================
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
75
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
76
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
77 **References**
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
78
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
79 If you use this Galaxy tool in work leading to a scientific publication please
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
80 cite the following papers:
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
81
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
82 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
83 Galaxy tools and workflows for sequence analysis with applications
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
84 in molecular plant pathology. PeerJ 1:e167
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
85 http://dx.doi.org/10.7717/peerj.167
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
86
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
87 Jehl, Arnold and Rattei (2011).
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
88 Effective - a database of predicted secreted bacterial proteins
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
89 Nucleic Acids Research, 39(Database issue), D591-5.
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
90 http://dx.doi.org/10.1093/nar/gkq1154
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
91
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
92 Arnold, Brandmaier, Kleine, Tischler, Heinz, Behrens, Niinikoski, Mewes, Horn and Rattei (2009).
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
93 Sequence-based prediction of type III secreted proteins.
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
94 PLoS Pathog. 5(4):e1000376.
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
95 http://dx.doi.org/10.1371/journal.ppat.1000376
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
96
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
97 See also http://effectors.org/
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
98
4
0c21abf1073b Uploaded v0.0.11 take 3, adding links to Tool Shed entry
peterjc
parents: 3
diff changeset
99 This wrapper is available to install into other Galaxy Instances via the Galaxy
0c21abf1073b Uploaded v0.0.11 take 3, adding links to Tool Shed entry
peterjc
parents: 3
diff changeset
100 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/effectivet3
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
101 </help>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
102 </tool>