annotate README.rst @ 4:b14c822a37fe draft

Uploaded v0.0.1d, README file with clearer citation instructions.
author peterjc
date Mon, 19 Aug 2013 11:38:03 -0400
parents
children 5f3cc8229771
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.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
7 This workflow was used in Kikuchi et al (2001), and is a simplification of
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
8 the candidate effector protocol described in Jones et al (2009).
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
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
13 Citation
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
14 ========
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
15
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
16 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
17 to a scientific publication, please cite:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
18
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
19 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
20 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
21 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
22 Humana Press, Springer. In press.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
23
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
24 Also consider citing:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
25
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
26 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
27 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
28 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
29
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
30 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
31 Predicting transmembrane protein topology with a hidden Markov model:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
32 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
33 http://dx.doi.org/10.1006/jmbi.2000.4315
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
34
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
35
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
36 Additional References
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
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
39 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
40 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
41 pathogen Bursaphelenchus xylophilus. PLoS Pathog 7: e1002219.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
42 http://dx.doi.org/10.1371/journal.ppat.1002219
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 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
45 Identification and functional characterization of effectors in expressed
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
46 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
47 Globodera pallida. Mol Plant Pathol 10: 815–28.
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
48 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
49
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
50
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
51 Availability
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
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
54 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
55 Galaxy Tool Shed:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
56
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
57 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
58
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
59 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
60
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
61 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
62
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
63 Development is being done on github here:
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 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
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 Dependencies
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 ============
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 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
72
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 * 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
74 * 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
75
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
76 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
77 dependencies required for this workflow which require manual
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
78 installation (SignalP v3.0 and TMHMM v2.0).
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
79
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 Developers
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 ==========
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 This workflow is under source code control here:
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
85
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
86 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
87
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
88 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
89
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
90 $ 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
91
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
92 Check this,
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 $ tar -tzf secreted_protein_workflow.tar.gz
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
95 README.rst
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
96 repository_dependencies.xml
b14c822a37fe Uploaded v0.0.1d, README file with clearer citation instructions.
peterjc
parents:
diff changeset
97 secreted_protein_workflow.ga