annotate tools/nlstradamus/nlstradamus.xml @ 3:b2e648e55ed7 draft

Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
author peterjc
date Wed, 18 Sep 2013 06:15:33 -0400
parents 9ec94203d895
children 1458e60f3fd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
1 <tool id="nlstradamus" name="NLStradamus" version="0.0.8">
2
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
2 <description>Find nuclear localization signals (NLSs) in protein sequences</description>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
3 <command>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
4 NLStradamus -i $fasta_file -t $threshold -m $model -a $algorithm -tab > $tabular_file
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
5 </command>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
6 <stdio>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
7 <!-- Assume anything other than zero is an error -->
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
8 <exit_code range="1:" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
9 <exit_code range=":-1" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
10 </stdio>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
11 <inputs>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
12 <param name="fasta_file" type="data" format="fasta" label="FASTA file of protein sequences"/>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
13 <param name="model" type="select" display="radio" label="Model">
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
14 <option value="1" selected="True">Two state</option>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
15 <option value="2">Four state</option>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
16 </param>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
17 <param name="algorithm" type="select" display="radio" label="Algorithm">
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
18 <option value="0">Viterbi</option>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
19 <option value="1" selected="True">Posterior with threshold</option>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
20 <option value="2">Both</option>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
21 </param>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
22 <param name="threshold" type="float" label="Posterior theshold" value="0.6">
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
23 <validator type="in_range" min="0" max="1" message="Threshold value should be between 0 and 1."/>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
24 </param>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
25 </inputs>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
26 <outputs>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
27 <data name="tabular_file" format="tabular" label="NLStradamus results" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
28 </outputs>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
29 <requirements>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
30 <requirement type="binary">NLStradamus</requirement>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
31 <requirement type="package" version="1.8">NLStradamus</requirement>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
32 </requirements>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
33 <tests>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
34 <test>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
35 <param name="fasta_file" value="four_human_proteins.fasta" ftype="fasta" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
36 <param name="model" value="1" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
37 <param name="algorithm" value="1" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
38 <param name="threshold" value="0.6" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
39 <output name="tabular_file" file="four_human_proteins.nlstradamus.tabular" ftype="tabular" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
40 </test>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
41 <test>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
42 <param name="fasta_file" value="empty.fasta" ftype="fasta" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
43 <param name="model" value="2" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
44 <param name="algorithm" value="2" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
45 <param name="threshold" value="0.125"/>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
46 <output name="tabular_file" file="empty_nlstradamus.tabular" ftype="tabular" />
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
47 </test>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
48 </tests>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
49 <help>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
50
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
51 **What it does**
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
52
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
53 This calls the NLStradamus tool for prediction of nuclear localization
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
54 signals (NLSs), which uses a Hidden Markov Model (HMM).
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
55
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
56 The input is a FASTA file of protein sequences, and the output is tabular
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
57 with six columns (one row per NLS):
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
58
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
59 ====== ===================================================================
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
60 Column Description
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
61 ------ -------------------------------------------------------------------
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
62 c1 Sequence identifier
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
63 c2 Algorithm (posterior or Viterbi)
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
64 c3 Score (probability between threshold and 1 for posterior algorithm)
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
65 c4 Start
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
66 c5 End
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
67 c6 Sequence of NLS
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
68 ====== ===================================================================
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
69
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
70 -----
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
71
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
72 **References**
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
73
3
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
74
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
75 If you use this Galaxy tool in work leading to a scientific publication please
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
76 cite the following papers:
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
77
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
78 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
79 Galaxy tools and workflows for sequence analysis with applications
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
80 in molecular plant pathology. PeerJ 1:e167
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
81 http://dx.doi.org/10.7717/peerj.167
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
82
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
83 A. N. Nguyen Ba, A. Pogoutse, N. Provart, A. M. Moses (2009).
2
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
84 NLStradamus: a simple Hidden Markov Model for nuclear localization signal prediction.
3
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
85 BMC Bioinformatics 10(1):202.
2
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
86 http://dx.doi.org/10.1186/1471-2105-10-202
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
87
3
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
88 See also http://www.moseslab.csb.utoronto.ca/NLStradamus
2
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
89
3
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
90 This wrapper is available to install into other Galaxy Instances via the Galaxy
b2e648e55ed7 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
91 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/nlstradamus
2
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
92 </help>
9ec94203d895 Uploaded v0.0.7 with automatic installation of the C++ binary.
peterjc
parents:
diff changeset
93 </tool>