annotate tools/effectiveT3/effectiveT3.xml @ 35:e2711662802b draft default tip

planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit d67596914a7bbe183851437eaafe8c7305877e5a-dirty
author peterjc
date Fri, 22 Feb 2019 10:13:22 -0500
parents 011cfce866f1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
1129cafdf0ae planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit b557cc18c85dcc5147b80c71f99c16a7015e12b2-dirty
peterjc
parents: 29
diff changeset
1 <tool id="effectiveT3" name="Effective T3" version="0.0.20">
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>
28
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
6 <version_command>
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
7 python $__tool_directory__/effectiveT3.py --version
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
8 </version_command>
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
9 <command detect_errors="aggressive">
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
10 python $__tool_directory__/effectiveT3.py '$module.fields.path'
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
11 #if $restrict.type=="cutoff":
28
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
12 'cutoff=$restrict.cutoff'
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
13 #else:
28
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
14 '$restrict.type'
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
15 #end if
28
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
16 '$fasta_file' '$tabular_file'
d6976a4c055b planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 2c1cc3ac829140d469816ec5e9892f96624270bf-dirty
peterjc
parents: 23
diff changeset
17 </command>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
18 <inputs>
33
8db22615d43f planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit e2fa1c599b6670b418479447fe5a181a97a6c834-dirty
peterjc
parents: 32
diff changeset
19 <param name="fasta_file" type="data" format="fasta" label="FASTA file of protein sequences"/>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
20 <param name="module" type="select" display="radio" label="Classification module">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
21 <options from_file="effectiveT3.loc">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
22 <column name="value" index="0"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
23 <column name="name" index="1"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
24 <column name="path" index="2"/>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
25 </options>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
26 </param>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
27 <conditional name="restrict">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
28 <param name="type" type="select" label="Cut-off setting">
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
29 <option value="selective">Selective (threshold set in module)</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
30 <option value="sensitive">Sensitive (threshold set in module)</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
31 <option value="cutoff">User defined cut-off</option>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
32 </param>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
33 <when value="selective" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
34 <when value="sensitive" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
35 <when value="cutoff" >
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
36 <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
37 </when>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
38 </conditional>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
39 </inputs>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
40 <outputs>
11
392279f2e120 Uploaded v0.0.12, more explicit output name
peterjc
parents: 4
diff changeset
41 <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
42 </outputs>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
43 <tests>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
44 <test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
45 <param name="fasta_file" value="four_human_proteins.fasta" ftype="fasta" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
46 <param name="module" value="animal" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
47 <param name="type" value="selective" />
15
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
48 <output name="tabular_file" file="four_human_proteins.effectiveT3.tabular" ftype="tabular" lines_diff="2"/>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
49 </test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
50 <test>
18
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
51 <param name="fasta_file" value="four_human_proteins.fasta" ftype="fasta" />
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
52 <param name="module" value="std_2_0_2" />
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
53 <param name="type" value="cutoff" />
20
f5e52dd0935f v0.0.16 tweak
peterjc
parents: 18
diff changeset
54 <param name="cutoff" value="0.8" />
18
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
55 <output name="tabular_file" file="four_human_proteins.effectiveT3_std2.tabular" ftype="tabular" />
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
56 </test>
999776f0aee4 v0.0.16, adding new model TTSS-STD-2.0.2.jar
peterjc
parents: 16
diff changeset
57 <test>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
58 <param name="fasta_file" value="empty.fasta" ftype="fasta" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
59 <param name="module" value="plant" />
15
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
60 <param name="type" value="sensitive" />
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
61 <output name="tabular_file" file="empty_effectiveT3.tabular" ftype="tabular" />
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
62 </test>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
63 </tests>
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
64 <help>
33
8db22615d43f planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit e2fa1c599b6670b418479447fe5a181a97a6c834-dirty
peterjc
parents: 32
diff changeset
65
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
66 **What it does**
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
67
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
68 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
69
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
70 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
71
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
72 ====== ==============================================================================
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
73 Column Description
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
74 ------ ------------------------------------------------------------------------------
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
75 1 Sequence identifier
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
76 2 Sequence description (from the FASTA file)
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
77 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
78 4 Predicted effector (true/false)
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
79 ====== ==============================================================================
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
80
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
81
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
82 **References**
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
83
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
84 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
85 cite the following papers:
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 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
88 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
89 in molecular plant pathology. PeerJ 1:e167
34
011cfce866f1 planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 3ab3d1a9650dec0533344d710ceb027e482d2b10-dirty
peterjc
parents: 33
diff changeset
90 https://doi.org/10.7717/peerj.167
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
91
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
92 Jehl, Arnold and Rattei (2011).
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
93 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
94 Nucleic Acids Research, 39(Database issue), D591-5.
34
011cfce866f1 planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 3ab3d1a9650dec0533344d710ceb027e482d2b10-dirty
peterjc
parents: 33
diff changeset
95 https://doi.org/10.1093/nar/gkq1154
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
96
13
169f8af5dd80 Uploaded v0.0.12b, can use accents in <help> RST
peterjc
parents: 12
diff changeset
97 Arnold, Brandmaier, Kleine, Tischler, Heinz, Behrens, Niinikoski, Mewes, Horn and Rattei (2009).
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
98 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
99 PLoS Pathog. 5(4):e1000376.
34
011cfce866f1 planemo upload for repository https://github.com/peterjc/pico_galaxy/tree/master/tools/effectiveT3 commit 3ab3d1a9650dec0533344d710ceb027e482d2b10-dirty
peterjc
parents: 33
diff changeset
100 https://doi.org/10.1371/journal.ppat.1000376
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
101
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents: 11
diff changeset
102 See also http://effectors.org/
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
103
4
0c21abf1073b Uploaded v0.0.11 take 3, adding links to Tool Shed entry
peterjc
parents: 3
diff changeset
104 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
105 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/effectivet3
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
106 </help>
15
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
107 <citations>
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
108 <citation type="doi">10.7717/peerj.167</citation>
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
109 <citation type="doi">10.1093/nar/gkq1154</citation>
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
110 <citation type="doi">10.1371/journal.ppat.1000376</citation>
17fbf8b8a554 Uploaded v0.0.13, embed citation, relax test for floating point differences
peterjc
parents: 13
diff changeset
111 </citations>
2
66e9d4c44ca2 Uploaded v0.0.11, auto installation
peterjc
parents:
diff changeset
112 </tool>