annotate tools/clinod/clinod.xml @ 6:77cfe958b5ea draft

v0.0.9 record clinod version
author peterjc
date Tue, 01 Sep 2015 06:54:03 -0400
parents 9485cdfca57e
children f61366a4a14e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
1 <tool id="clinod" name="Nucleolar localization sequence Detector (NoD)" version="0.0.9">
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
2 <description>Find nucleolar localization signals (NoLSs) in protein sequences</description>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
3 <requirements>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
4 <requirement type="binary">java</requirement>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
5 <requirement type="package" version="1.3">clinod</requirement>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
6 </requirements>
5
9485cdfca57e v0.0.8 internal changes
peterjc
parents: 4
diff changeset
7 <stdio>
9485cdfca57e v0.0.8 internal changes
peterjc
parents: 4
diff changeset
8 <!-- Assume anything other than zero is an error -->
9485cdfca57e v0.0.8 internal changes
peterjc
parents: 4
diff changeset
9 <exit_code range="1:" />
9485cdfca57e v0.0.8 internal changes
peterjc
parents: 4
diff changeset
10 <exit_code range=":-1" />
9485cdfca57e v0.0.8 internal changes
peterjc
parents: 4
diff changeset
11 </stdio>
6
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
12 <version_command>
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
13 ##The first non-blank line contains the version information, e.g.
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
14 ##NucleOlar localization sequence Detector v. 1.3b (13 May 2011)
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
15 ##Question: Why don't we have to escape the dollar here?
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
16 java -jar $CLINOD/clinod-1.3.jar | grep -i "^NucleOlar localization sequence Detector"
77cfe958b5ea v0.0.9 record clinod version
peterjc
parents: 5
diff changeset
17 </version_command>
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
18 <command>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
19 ##The Galaxy Tool Shed installation should define $CLINOD to point at folder
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
20 ##containing both clinod-1.3.jar and the batchman binary:
4
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
21 java -jar \$CLINOD/clinod-1.3.jar -in="$fasta_file" -out="$tabular_file" -t="\$GALAXY_SLOTS" -f=MEDIUM_TAB -nonols -clean_sequence
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
22 ##TODO - Make the -clean_sequence argument a parameter?
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
23 </command>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
24 <inputs>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
25 <param name="fasta_file" type="data" format="fasta" label="FASTA file of protein sequences"/>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
26 </inputs>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
27 <outputs>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
28 <data name="tabular_file" format="tabular" label="NoD results" />
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
29 </outputs>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
30 <tests>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
31 <test>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
32 <param name="fasta_file" value="four_human_proteins.fasta" ftype="fasta" />
4
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
33 <output name="tabular_file" file="four_human_proteins.clinod-1.3.tabular" ftype="tabular" />
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
34 </test>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
35 </tests>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
36 <help>
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
37
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
38 **What it does**
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
39
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
40 This calls the command line version of the NoD tool from the Barton Group for
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
41 prediction of nucleolar localization sequences (NoLSs). The NoD tool uses an
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
42 artificial neural network trained on a set of human NoLSs.
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
43
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
44 The nucleolus is a sub-compartmentof the nucleus, thus an NoLS can be regarded
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
45 as a special nuclear localization sequence (NLS).
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
46
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
47 The input is a FASTA file of protein sequences, and the output is tabular with
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
48 four columns (multiple rows per protein):
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
49
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
50 ====== ===================
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
51 Column Description
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
52 ------ -------------------
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
53 1 Sequence identifier
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
54 2 Start of NoLS
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
55 3 End of NoLS
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
56 4 NoLS sequence
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
57 ====== ===================
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
58
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
59 If a sequence has no predicted NoLS, then there is no line in the output file
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
60 for it.
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
61
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
62 -----
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
63
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
64 **References**
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
65
3
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
66 If you use this Galaxy tool in work leading to a scientific publication please
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
67 cite the following papers:
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
68
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
69 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
70 Galaxy tools and workflows for sequence analysis with applications
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
71 in molecular plant pathology. PeerJ 1:e167
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
72 http://dx.doi.org/10.7717/peerj.167
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
73
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
74 M. S. Scott, F. M. Boisvert, M. D. McDowall, A. I. Lamond and G. J. Barton (2010).
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
75 Characterization and prediction of protein nucleolar localization sequences.
3
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
76 Nucleic Acids Research 38(21), 7388-7399.
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
77 http://dx.doi.org/10.1093/nar/gkq653
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
78
3
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
79 M. S. Scott, P. V. Troshin and G. J. Barton (2011).
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
80 NoD: a Nucleolar localization sequence detector for eukaryotic and viral proteins.
3
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
81 BMC Bioinformatics, 12:317.
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
82 http://dx.doi.org/10.1186/1471-2105-12-317
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
83
3
6a9debe4b860 Uploaded v0.0.6, MIT licence, reStructuredText README, citation information, development moved to GitHub
peterjc
parents: 2
diff changeset
84 See also http://www.compbio.dundee.ac.uk/www-nod/
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
85
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
86 This wrapper is available to install into other Galaxy Instances via the Galaxy
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
87 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/clinod
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
88
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
89 </help>
4
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
90 <citations>
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
91 <citation type="doi">10.7717/peerj.167</citation>
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
92 <citation type="doi">10.1093/nar/gkq653</citation>
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
93 <citation type="doi">10.1186/1471-2105-12-317</citation>
4d9a4a43861b Uploaded v0.0.7, uses $GALAXY_SLOTS and embeds citation in tool XML.
peterjc
parents: 3
diff changeset
94 </citations>
2
d1aebb0acee7 Uploaded v0.0.5, automated installation
peterjc
parents:
diff changeset
95 </tool>