annotate tools/protein_analysis/promoter2.xml @ 22:90e3d02f8013 draft

Uploaded v0.2.5 preview 6, can use accents in <help> RST
author peterjc
date Thu, 12 Sep 2013 11:06:04 -0400
parents a538e182fab3
children 41a42022f815
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
1 <tool id="promoter2" name="Promoter 2.0" version="0.0.6">
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
2 <description>Find eukaryotic PolII promoters in DNA sequences</description>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
3 <!-- If job splitting is enabled, break up the query file into parts -->
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
4 <!-- Using 2000 per chunk so 4 threads each doing 500 is ideal -->
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
5 <parallelism method="basic" split_inputs="fasta_file" split_mode="to_size" split_size="2000" merge_outputs="tabular_file"></parallelism>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
6 <command interpreter="python">
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
7 promoter2.py "\$NSLOTS" $fasta_file $tabular_file
19
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
8 ##I want the number of threads to be a Galaxy config option...
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
9 ##Set the number of threads in the runner entry in universe_wsgi.ini
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
10 ##which (on SGE at least) will set the $NSLOTS environment variable.
19
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
11 ##If the environment variable isn't set, get "", and the python wrapper
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
12 ##defaults to four threads.
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
13 </command>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
14 <stdio>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
15 <!-- Anything other than zero is an error -->
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
16 <exit_code range="1:" />
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
17 <exit_code range=":-1" />
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
18 </stdio>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
19 <inputs>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
20 <param name="fasta_file" type="data" format="fasta" label="FASTA file of DNA sequences"/>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
21 </inputs>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
22 <outputs>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
23 <data name="tabular_file" format="tabular" label="Promoter2 on ${fasta_file.name}" />
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
24 </outputs>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
25 <requirements>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
26 <requirement type="binary">promoter</requirement>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
27 </requirements>
16
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
28 <tests>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
29 <test>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
30 <param name="fasta_file" value="Adenovirus.fasta" ftype="fasta"/>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
31 <output name="tabular_file" file="Adenovirus.promoter2.tabular" ftype="tabular"/>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
32 </test>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
33 <test>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
34 <param name="fasta_file" value="empty.fasta" ftype="fasta"/>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
35 <output name="tabular_file" file="empty_promoter2.tabular" ftype="tabular"/>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
36 </test>
1d5486a02bc4 Uploaded v0.2.4, added unit tests for Promoter 2
peterjc
parents: 7
diff changeset
37 </tests>
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
38 <help>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
39
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
40 **What it does**
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
41
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
42 This calls the Promoter 2.0 tool for prediction of eukaryotic PolII promoter sequences using a Neural Network (NN) model.
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
43
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
44 The input is a FASTA file of nucleotide sequences (e.g. upstream regions of your genes), and the output is tabular with five columns (one row per promoter):
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
45
19
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
46 ====== ==================================================
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
47 Column Description
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
48 ------ --------------------------------------------------
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
49 1 Sequence identifier (first word of FASTA header)
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
50 2 Promoter position, e.g. 600
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
51 3 Promoter score, e.g. 1.063
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
52 4 Promoter likelihood, e.g. Highly likely prediction
4cd848c5590b Uploaded v0.2.5 preview 3, use $NSLOTS in the PSORT wrappers.
peterjc
parents: 17
diff changeset
53 ====== ==================================================
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
54
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
55 The scores are classified very simply as follows:
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
56
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
57 ========= ========================
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
58 Score Description
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
59 --------- ------------------------
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
60 below 0.5 ignored
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
61 0.5 - 0.8 Marginal prediction
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
62 0.8 - 1.0 Medium likely prediction
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
63 above 1.0 Highly likely prediction
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
64 ========= ========================
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
65
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
66 Internally the input FASTA file is divided into parts (to allow multiple processors to be used), and the raw output is reformatted into this tabular layout suitable for downstream analysis within Galaxy.
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
67
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
68 **References**
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
69
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
70 If you use this Galaxy tool in work leading to a scientific publication please
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
71 cite the following papers:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
72
22
90e3d02f8013 Uploaded v0.2.5 preview 6, can use accents in <help> RST
peterjc
parents: 20
diff changeset
73 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
74 Galaxy tools and workflows for sequence analysis with applications
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
75 in molecular plant pathology. PeerJ 1:e167
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
76 http://dx.doi.org/10.7717/peerj.167
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
77
22
90e3d02f8013 Uploaded v0.2.5 preview 6, can use accents in <help> RST
peterjc
parents: 20
diff changeset
78 Steen Knudsen (1999).
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
79 Promoter2.0: for the recognition of PolII promoter sequences.
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
80 Bioinformatics, 15:356-61.
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
81 http://dx.doi.org/10.1093/bioinformatics/15.5.356
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
82
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents: 19
diff changeset
83 See also http://www.cbs.dtu.dk/services/Promoter/output.php
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
84
17
af3174637834 Uploaded v0.2.5 preview 1, adding links to Tool Shed entry
peterjc
parents: 16
diff changeset
85 This wrapper is available to install into other Galaxy Instances via the Galaxy
af3174637834 Uploaded v0.2.5 preview 1, adding links to Tool Shed entry
peterjc
parents: 16
diff changeset
86 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
7
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
87 </help>
5e62aefb2918 Uploaded v0.1.2 to Test Tool Shed
peterjc
parents:
diff changeset
88 </tool>