annotate README.rst @ 13:120d01a025a9 draft

Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
author peterjc
date Fri, 04 Oct 2013 11:17:45 -0400
parents 923fa2577564
children 25076bddafe8
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
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
8 Availability
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
9 ============
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
10
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
11 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
12 Galaxy Tool Shed:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
13
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
14 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
15
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
16 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
17
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
18 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
19
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
20 Development is being done on github here:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
21
13
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
22 https://github.com/peterjc/pico_galaxy/tree/master/workflows/rxlr_venn_workflow
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
23
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
24
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
25 Sample Data
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
26 ===========
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
27
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
28 This workflow was developed and run on several *Phytophthora* species.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
29 For example, try the "Phyca11" protein set for *Phytophthora capsici*:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
30
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
31 http://genome.jgi-psf.org/Phyca11/download/Phyca11_filtered_proteins.fasta.gz
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
32
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
33 You can upload this directly into Galaxy via this URL. Galaxy will handle
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
34 removing the gzip compression to give you the FASTA protein file which
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
35 has 19,805 protein sequences. The expected results:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
36
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
37 * 89 RXLRs using Whisson et al. (2007)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
38 * 124 RXLRs using Win et al. (2007)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
39 * 162 RXLRs using Bhattacharjee et al. (2006)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
40
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
41 Of these, only 79 sequences pass all three of the RXLR prediction tools,
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
42 while 19643 have no RXLR matches at all.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
43
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
44 .. image:: Phyca11_example_output.png
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
45 :height: 400px
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
46 :width: 400px
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
47
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
48
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
49 Citation
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
50 ========
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
51
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
52 If you use this workflow directly, or a derivative of it, in work leading
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
53 to a scientific publication, please cite:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
54
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
55 Cock, P.J.A. and Pritchard, L. 2013. Galaxy as a platform for identifying
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
56 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
57 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
58 Humana Press, Springer. In press.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
59
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
60 For the associated RXLR Galaxy tool, please cite:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
61
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
62 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
63 Galaxy tools and workflows for sequence analysis with applications
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
64 in molecular plant pathology. PeerJ 1:e167
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
65 http://dx.doi.org/10.7717/peerj.167
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
66
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
67 For the three underlying methods, please cite:
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
68
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
69 Whisson, S.C., Boevink, C.V., Moleleki, L., et al. (2007)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
70 A translocation signal for delivery of oomycete effector proteins into
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
71 host plant cells. Nature 450:115-118.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
72 http://dx.doi.org/10.1038/nature06203
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
73
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
74 Win, J., Morgan, W., Bos, J., et al. (2007)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
75 Adaptive evolution has targeted the C-terminal domain of the RXLR effectors
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
76 of plant pathogenic oomycetes. The Plant Cell 19:2349-2369.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
77 http://dx.doi.org/10.1105/tpc.107.051037
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
78
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
79 Bhattacharjee, S., Luisa Hiller, N., Liolios, K., et al. (2006)
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
80 The malarial host-targeting signal is conserved in the Irish potato famine
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
81 pathogen. PLoS Pathogens 2(5):e50.
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
82 http://dx.doi.org/10.1371/journal.ppat.0020050
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
83
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 Dependencies
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
86 ============
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
87
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
88 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
89
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
90 * 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
91 * 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
92 * 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
93
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
94 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
95 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
96 HMMER v2.0, and the R/Bioconductor package limma).
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
97
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
98
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
99 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
100 =======
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
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 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
104 ------- ----------------------------------------------------------------------
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
105 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
106 - 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
107 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
108 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
109 - 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
110 is a README file with sample data, and a requested citation.
13
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
111 - Bundle sample output image for display in this README file.
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
112 ======= ======================================================================
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
113
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
114
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
115 Developers
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
116 ==========
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 This workflow is under source code control here:
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
119
13
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
120 https://github.com/peterjc/pico_galaxy/tree/master/workflows/rxlr_venn_workflow
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
121
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
122 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
123
13
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
124 $ tar -cf rxlr_venn_workflow.tar.gz README.rst repository_dependencies.xml rxlr_venn_workflow.ga Phyca11_example_output.png
6
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
125
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
126 Check this,
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
127
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
128 $ tar -tzf rxlr_venn_workflow.tar.gz
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
129 README.rst
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
130 repository_dependencies.xml
b1047023ffbb Uploaded v0.0.1f, README file with clearer citation instructions.
peterjc
parents:
diff changeset
131 rxlr_venn_workflow.ga
13
120d01a025a9 Uploaded v0.0.2a, bundle sample image for display in README.rst (no functional changes)
peterjc
parents: 12
diff changeset
132 Phyca11_example_output.png