Mercurial > repos > peterjc > secreted_protein_workflow

annotate README.rst @ 8:ec6f6ba3bc78 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.2b, adding link to Tool Shed in the workflow annotation (so that end users can find the README file).
author peterjc
date Wed, 21 Aug 2013 12:31:56 -0400
parents 36b2c2b5051e
children 3b5eecc9551e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
1 This is package is a Galaxy workflow for the identification of candidate
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
2 secreted proteins from a given protein FASTA file.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
3
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
4 It runs SignalP v3.0 (Bendtsen et al. 2004) and selects only proteins with a
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
5 strong predicted signal peptide, and then runs TMHMM v2.0 (Krogh et al. 2001)
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
6 on those, and selects only proteins without a predicted trans-membrane helix.
5
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
7 This workflow was used in Kikuchi et al. (2011), and is a simplification of
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
8 the candidate effector protocol described in Jones et al. (2009).
4
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
9
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
10 See http://www.galaxyproject.org for information about the Galaxy Project.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
11
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
12
5
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
13 Sample Data
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
14 ===========
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
15
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
16 This workflow was developed and run on several nematode species. For example,
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
17 try the protein set for Bursaphelenchus xylophilus (Kikuchi et al. 2011):
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
18
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
19 ftp://ftp.sanger.ac.uk/pub/pathogens/Bursaphelenchus/xylophilus/Assembly-v1.2/BUX.v1.2.genedb.protein.fa.gz
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
20
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
21 You can upload this directly into Galaxy via this URL. Galaxy will handle
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
22 removing the gzip compression to give you the FASTA protein file which has
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
23 18,074 sequences. The expected result (selecting organism type Eukaryote)
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
24 is a FASTA protein file of 2,297 predicted secreted protein sequences.
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
25
5f3cc8229771 Uploaded v0.0.1e with links to sample data in README
peterjc
parents: 4
diff changeset
26
4
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
27 Citation
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
28 ========
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
29
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
30 If you use this workflow directly, or a derivative of it, in work leading
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
31 to a scientific publication, please cite:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
32
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
33 Cock, P.J.A. and Pritchard, L. 2013. Galaxy as a platform for identifying
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
34 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
35 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
36 Humana Press, Springer. In press.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
37
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
38 Also consider citing:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
39
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
40 Bendtsen, J.D., Nielsen, H., von Heijne, G., Brunak, S. (2004)
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
41 Improved prediction of signal peptides: SignalP 3.0. J Mol Biol 340: 783–95.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
42 http://dx.doi.org/10.1016/j.jmb.2004.05.028
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
43
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
44 Krogh, A., Larsson, B., von Heijne, G., Sonnhammer, E. (2001)
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
45 Predicting transmembrane protein topology with a hidden Markov model:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
46 application to complete genomes. J Mol Biol 305: 567- 580.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
47 http://dx.doi.org/10.1006/jmbi.2000.4315
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
48
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
49
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
50 Additional References
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
51 =====================
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
52
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
53 Kikuchi, T., Cotton, J.A., Dalzell, J.J., Hasegawa. K., et al. (2011)
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
54 Genomic insights into the origin of parasitism in the emerging plant
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
55 pathogen Bursaphelenchus xylophilus. PLoS Pathog 7: e1002219.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
56 http://dx.doi.org/10.1371/journal.ppat.1002219
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
57
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
58 Jones, J.T., Kumar, A., Pylypenko, L.A., Thirugnanasambandam, A., et al. (2009)
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
59 Identification and functional characterization of effectors in expressed
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
60 sequence tags from various life cycle stages of the potato cyst nematode
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
61 Globodera pallida. Mol Plant Pathol 10: 815–28.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
62 http://dx.doi.org/10.1111/j.1364-3703.2009.00585.x
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
63
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
64
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
65 Availability
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
66 ============
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
67
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
68 This workflow is available to download and/or install from the main
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 Galaxy Tool Shed:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
70
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
71 http://toolshed.g2.bx.psu.edu/view/peterjc/secreted_protein_workflow
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
72
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 Test releases (which should not normally be used) are on the Test Tool Shed:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
74
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
75 http://testtoolshed.g2.bx.psu.edu/view/peterjc/secreted_protein_workflow
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
76
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
77 Development is being done on github here:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
78
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
79 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/secreted_protein_workflow
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
80
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
81
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 Dependencies
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
83 ============
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
84
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
85 These dependencies should be resolved automatically via the Galaxy Tool Shed:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
86
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
87 * http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
88 * http://toolshed.g2.bx.psu.edu/view/peterjc/seq_filter_by_id
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
89
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
90 However, at the time of writing those Galaxy tools have their own
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
91 dependencies required for this workflow which require manual
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
92 installation (SignalP v3.0 and TMHMM v2.0).
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
93
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
94
6
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
95 History
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
96 =======
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
97
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
98 ======= ======================================================================
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
99 Version Changes
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
100 ------- ----------------------------------------------------------------------
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
101 v0.0.1 - Initial release to Tool Shed (May, 2013)
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
102 - Expanded README file to include example data
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
103 v0.0.2 - Updated versions of the tools used, inclulding core Galaxy Filter
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
104 tool to avoid warning about new ``header_lines`` parameter.
8
ec6f6ba3bc78 Uploaded v0.0.2b, adding link to Tool Shed in the workflow annotation (so that end users can find the README file).
peterjc
parents: 6
diff changeset
105 - Added link to Tool Shed in the workflow annotation explaining there
ec6f6ba3bc78 Uploaded v0.0.2b, adding link to Tool Shed in the workflow annotation (so that end users can find the README file).
peterjc
parents: 6
diff changeset
106 is a README file with sample data, and a requested citation.
6
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
107 ======= ======================================================================
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
108
36b2c2b5051e Uploaded v0.0.2 with updated tool versions, should fix header_lines warning from Filter1 tool.
peterjc
parents: 5
diff changeset
109
4
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
110 Developers
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
111 ==========
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
112
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
113 This workflow is under source code control here:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
114
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
115 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/secreted_protein_workflow
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
116
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
117 To prepare the tar-ball for uploading to the Tool Shed, I use this:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
118
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
119 $ tar -cf secreted_protein_workflow.tar.gz README.rst repository_dependencies.xml secreted_protein_workflow.ga
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
120
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
121 Check this,
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
122
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
123 $ tar -tzf secreted_protein_workflow.tar.gz
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
124 README.rst
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
125 repository_dependencies.xml
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
126 secreted_protein_workflow.ga