annotate README.rst @ 12:923fa2577564 draft

Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
author peterjc
date Wed, 21 Aug 2013 13:00:43 -0400
parents de29af5da85e
children 120d01a025a9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
1 This is package is a Galaxy workflow for comparing three RXLR prediction
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
2 methods with a Venn Diagram, and creates a FASTA file of any proteins
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
3 passing all three methods.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
4
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
5 See http://www.galaxyproject.org for information about the Galaxy Project.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
7
7
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
8 Sample Data
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
9 ===========
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
10
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
11 This workflow was developed and run on several Phytophthora species.
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
12 For example, try the "Phyca11" protein set for Phytophthora capsici:
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
13
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
14 http://genome.jgi-psf.org/Phyca11/download/Phyca11_filtered_proteins.fasta.gz
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
15
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
16 You can upload this directly into Galaxy via this URL. Galaxy will handle
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
17 removing the gzip compression to give you the FASTA protein file which
8
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
18 has 19,805 protein sequences. The expected results:
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
19
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
20 * 89 RXLRs using Whisson et al. (2007)
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
21 * 124 RXLRs using Win et al. (2007)
11
de29af5da85e Uploaded v0.0.1l, fixed typo in README file
peterjc
parents: 10
diff changeset
22 * 162 RXLRs using Bhattacharjee et al. (2006)
8
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
23
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
24 Of these, only 79 sequences pass all three of the RXLR prediction tools,
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
25 while 19643 have no RXLR matches at all.
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
26
10
a24a1614ef11 Uploaded v0.0.1k, using HTTPS for embedded image (needed to display the README file nicely on GitHub)
peterjc
parents: 9
diff changeset
27 .. image:: https://raw.github.com/peterjc/picobio/master/galaxy_workflows/rxlr_venn_workflow/Phyca11_example_output.png
8
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
28 :height: 400px
2dfe8b788fb6 Uploaded v0.0.1h, attempt to show image in README file
peterjc
parents: 7
diff changeset
29 :width: 400px
7
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
30
51aeb3d4799d Uploaded v0.0.1g, add Phyca11 example to README
peterjc
parents: 6
diff changeset
31
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
32 Citation
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
33 ========
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
34
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
35 If you use this workflow directly, or a derivative of it, in work leading
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
36 to a scientific publication, please cite:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
37
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
38 Cock, P.J.A. and Pritchard, L. 2013. Galaxy as a platform for identifying
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
39 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
40 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
41 Humana Press, Springer. In press.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
42
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
43 Whisson, S.C., Boevink, C.V., Moleleki, L., et al. (2007)
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
44 A translocation signal for delivery of oomycete effector proteins into
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
45 host plant cells. Nature 450:115-118.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
46 http://dx.doi.org/10.1038/nature06203
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
47
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
48 Win, J., Morgan, W., Bos, J., et al. (2007)
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
49 Adaptive evolution has targeted the C-terminal domain of the RXLR effectors
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
50 of plant pathogenic oomycetes. The Plant Cell 19:2349-2369.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
51 http://dx.doi.org/10.1105/tpc.107.051037
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
52
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
53 Bhattacharjee, S., Luisa Hiller, N., Liolios, K., et al. (2006)
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
54 The malarial host-targeting signal is conserved in the Irish potato famine
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
55 pathogen. PLoS Pathogens 2(5):e50.
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
56 http://dx.doi.org/10.1371/journal.ppat.0020050
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
57
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
58
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
59 Availability
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
60 ============
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
61
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
62 This workflow is available to download and/or install from the main
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
63 Galaxy Tool Shed:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
64
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
65 http://toolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
66
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
67 Test releases (which should not normally be used) are on the Test Tool Shed:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
68
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
70
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
71 Development is being done on github here:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
72
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
74
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
75
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
76 Dependencies
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
77 ============
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
78
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
79 These dependencies should be resolved automatically via the Galaxy Tool Shed:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
80
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
81 * http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 * http://toolshed.g2.bx.psu.edu/view/peterjc/seq_filter_by_id
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
83 * http://toolshed.g2.bx.psu.edu/view/peterjc/venn_list
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
84
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
85 However, at the time of writing those Galaxy tools have their own dependencies
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
86 required for this workflow which require manual installation (SignalP v3.0,
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
87 HMMER v2.0, and the R/Bioconductor package limma).
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
88
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
89
12
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
90 History
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
91 =======
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
92
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
93 ======= ======================================================================
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
94 Version Changes
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
95 ------- ----------------------------------------------------------------------
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
96 v0.0.1 - Initial release to Tool Shed (May, 2013)
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
97 - Expanded README file to include example data
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
98 v0.0.2 - Updated versions of the tools used, inclulding core Galaxy Filter
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
99 tool to avoid warning about new ``header_lines`` parameter.
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
100 - Added link to Tool Shed in the workflow annotation explaining there
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
101 is a README file with sample data, and a requested citation.
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
102 ======= ======================================================================
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
103
923fa2577564 Uploaded v0.0.2, bump tool version numbers to fix warning about Filter1 parameter, adding link to Tool Shed in annotation. No functional changes.
peterjc
parents: 11
diff changeset
104
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
105 Developers
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
106 ==========
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
107
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
108 This workflow is under source code control here:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
109
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
110 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
111
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
112 To prepare the tar-ball for uploading to the Tool Shed, I use this:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
113
9
d893133128d8 Uploaded v0.0.1i, try remote linking to image in README.rst
peterjc
parents: 8
diff changeset
114 $ tar -cf rxlr_venn_workflow.tar.gz README.rst repository_dependencies.xml rxlr_venn_workflow.ga
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
115
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
116 Check this,
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
117
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
118 $ tar -tzf rxlr_venn_workflow.tar.gz
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
119 README.rst
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
120 repository_dependencies.xml
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
121 rxlr_venn_workflow.ga