annotate README.rst @ 3:1a1ab2f2b5b5 draft

README file with clearer citation instructions.
author peterjc
date Mon, 19 Aug 2013 11:35:52 -0400
parents
children 3c280e01b920
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
1 This is package is a Galaxy workflow for comparing three RXLR prediction
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
2 methods with a Venn Diagram, and creates a FASTA file of any proteins
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
3 passing all three methods.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
4
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
5 See http://www.galaxyproject.org for information about the Galaxy Project.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
6
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
7
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
8 Citation
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
9 ========
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
10
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
11 If you use this workflow directly, or a derivative of it, in work leading
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
12 to a scientific publication, please cite:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
13
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
14 Cock, P.J.A. and Pritchard, L. 2013. Galaxy as a platform for identifying
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
15 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
16 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
17 Humana Press, Springer. In press.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
18
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
19 Whisson, S.C., Boevink, C.V., Moleleki, L., et al. (2007)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
20 A translocation signal for delivery of oomycete effector proteins into
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
21 host plant cells. Nature 450:115-118.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
22 http://dx.doi.org/10.1038/nature06203
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
23
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
24 Win, J., Morgan, W., Bos, J., et al. (2007)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
25 Adaptive evolution has targeted the C-terminal domain of the RXLR effectors
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
26 of plant pathogenic oomycetes. The Plant Cell 19:2349-2369.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
27 http://dx.doi.org/10.1105/tpc.107.051037
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
28
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
29 Bhattacharjee, S., Luisa Hiller, N., Liolios, K., et al. (2006)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
30 The malarial host-targeting signal is conserved in the Irish potato famine
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
31 pathogen. PLoS Pathogens 2(5):e50.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
32 http://dx.doi.org/10.1371/journal.ppat.0020050
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
33
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
34
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
35 Availability
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
36 ============
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
37
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
38 This workflow is available to download and/or install from the main
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
39 Galaxy Tool Shed:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
40
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
41 http://toolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
42
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
43 Test releases (which should not normally be used) are on the Test Tool Shed:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
44
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
45 http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
46
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
47 Development is being done on github here:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
48
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
49 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
50
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
51
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
52 Dependencies
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
53 ============
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
54
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
55 These dependencies should be resolved automatically via the Galaxy Tool Shed:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
56
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
57 * http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
58 * http://toolshed.g2.bx.psu.edu/view/peterjc/seq_filter_by_id
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
59 * http://toolshed.g2.bx.psu.edu/view/peterjc/venn_list
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
60
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
61 However, at the time of writing those Galaxy tools have their own dependencies
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
62 required for this workflow which require manual installation (SignalP v3.0,
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
63 HMMER v2.0, and the R/Bioconductor package limma).
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
64
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
65
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
66 Developers
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
67 ==========
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
68
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 This workflow is under source code control here:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
70
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
71 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
72
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 To prepare the tar-ball for uploading to the Tool Shed, I use this:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
74
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
75 $ tar -cf rxlr_venn_workflow.tar.gz README.rst repository_dependencies.xml rxlr_venn_workflow.ga
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
76
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
77 Check this,
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
78
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
79 $ tar -tzf rxlr_venn_workflow.tar.gz
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
80 README.rst
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
81 repository_dependencies.xml
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 rxlr_venn_workflow.ga