annotate README.rst @ 1:606da4e1d925 draft

README file with clearer citation instructions.
author peterjc
date Mon, 19 Aug 2013 11:37:04 -0400
parents
children 3a0c0d1c388f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
1 This is package is a Galaxy workflow for the identification of candidate
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
2 secreted proteins from a given protein FASTA file.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
3
606da4e1d925 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
606da4e1d925 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)
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
6 on those, and selects only proteins without a predicted trans-membrane helix.
606da4e1d925 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
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
8 the candidate effector protocol described in Jones et al (2009).
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
9
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
10 See http://www.galaxyproject.org for information about the Galaxy Project.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
11
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
12
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
13 Citation
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
14 ========
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
15
606da4e1d925 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
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
17 to a scientific publication, please cite:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
18
606da4e1d925 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
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
20 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
21 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
22 Humana Press, Springer. In press.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
23
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
24 Also consider citing:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
25
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
26 Bendtsen, J.D., Nielsen, H., von Heijne, G., Brunak, S. (2004)
606da4e1d925 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.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
28 http://dx.doi.org/10.1016/j.jmb.2004.05.028
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
29
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
30 Krogh, A., Larsson, B., von Heijne, G., Sonnhammer, E. (2001)
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
31 Predicting transmembrane protein topology with a hidden Markov model:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
32 application to complete genomes. J Mol Biol 305: 567- 580.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
33 http://dx.doi.org/10.1006/jmbi.2000.4315
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
34
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
35
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
36 Additional References
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
37 =====================
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
38
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
39 Kikuchi, T., Cotton, J.A., Dalzell, J.J., Hasegawa. K., et al. (2011)
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
40 Genomic insights into the origin of parasitism in the emerging plant
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
41 pathogen Bursaphelenchus xylophilus. PLoS Pathog 7: e1002219.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
42 http://dx.doi.org/10.1371/journal.ppat.1002219
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
43
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
44 Jones, J.T., Kumar, A., Pylypenko, L.A., Thirugnanasambandam, A., et al. (2009)
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
45 Identification and functional characterization of effectors in expressed
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
46 sequence tags from various life cycle stages of the potato cyst nematode
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
47 Globodera pallida. Mol Plant Pathol 10: 815–28.
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
48 http://dx.doi.org/10.1111/j.1364-3703.2009.00585.x
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
49
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
50
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
51 Availability
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
52 ============
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
53
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
54 This workflow is available to download and/or install from the main
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
55 Galaxy Tool Shed:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
56
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
57 http://toolshed.g2.bx.psu.edu/view/peterjc/secreted_protein_workflow
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
58
606da4e1d925 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:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
60
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
61 http://testtoolshed.g2.bx.psu.edu/view/peterjc/secreted_protein_workflow
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
62
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
63 Development is being done on github here:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
64
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
65 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/secreted_protein_workflow
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
66
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
67
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
68 Dependencies
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 ============
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
70
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
71 These dependencies should be resolved automatically via the Galaxy Tool Shed:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
72
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 * http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
74 * http://toolshed.g2.bx.psu.edu/view/peterjc/seq_filter_by_id
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
75
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
76 However, at the time of writing those Galaxy tools have their own
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
77 dependencies required for this workflow which require manual
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
78 installation (SignalP v3.0 and TMHMM v2.0).
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
79
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
80
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
81 Developers
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 ==========
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
83
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
84 This workflow is under source code control here:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
85
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
86 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/secreted_protein_workflow
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
87
606da4e1d925 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:
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
89
606da4e1d925 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
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
91
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
92 Check this,
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
93
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
94 $ tar -tzf secreted_protein_workflow.tar.gz
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
95 README.rst
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
96 repository_dependencies.xml
606da4e1d925 README file with clearer citation instructions.
peterjc
parents:
diff changeset
97 secreted_protein_workflow.ga