annotate README.rst @ 4:3c280e01b920 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:01:51 -0400
parents 1a1ab2f2b5b5
children 4726b640f221
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
4
3c280e01b920 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: 3
diff changeset
8 Sample Data
3c280e01b920 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: 3
diff changeset
9 ===========
3c280e01b920 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: 3
diff changeset
10
3c280e01b920 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: 3
diff changeset
11 This workflow was developed and run on several Phytophthora species.
3c280e01b920 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: 3
diff changeset
12 For example, try the "Phyca11" protein set for Phytophthora capsici:
3c280e01b920 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: 3
diff changeset
13
3c280e01b920 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: 3
diff changeset
14 http://genome.jgi-psf.org/Phyca11/download/Phyca11_filtered_proteins.fasta.gz
3c280e01b920 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: 3
diff changeset
15
3c280e01b920 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: 3
diff changeset
16 You can upload this directly into Galaxy via this URL. Galaxy will handle
3c280e01b920 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: 3
diff changeset
17 removing the gzip compression to give you the FASTA protein file which
3c280e01b920 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: 3
diff changeset
18 has 19,805 protein sequences. The expected results:
3c280e01b920 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: 3
diff changeset
19
3c280e01b920 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: 3
diff changeset
20 * 89 RXLRs using Whisson et al. (2007)
3c280e01b920 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: 3
diff changeset
21 * 124 RXLRs using Win et al. (2007)
3c280e01b920 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: 3
diff changeset
22 * 162 RXLRs using Bhattacharjee et al. (2006)
3c280e01b920 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: 3
diff changeset
23
3c280e01b920 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: 3
diff changeset
24 Of these, only 79 sequences pass all three of the RXLR prediction tools,
3c280e01b920 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: 3
diff changeset
25 while 19643 have no RXLR matches at all.
3c280e01b920 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: 3
diff changeset
26
3c280e01b920 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: 3
diff changeset
27 .. image:: https://raw.github.com/peterjc/picobio/master/galaxy_workflows/rxlr_venn_workflow/Phyca11_example_output.png
3c280e01b920 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: 3
diff changeset
28 :height: 400px
3c280e01b920 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: 3
diff changeset
29 :width: 400px
3c280e01b920 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: 3
diff changeset
30
3c280e01b920 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: 3
diff changeset
31
3
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
32 Citation
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 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
36 to a scientific publication, please cite:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
37
1a1ab2f2b5b5 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
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
39 candidate pathogen effectors. Chapter 1 in "Plant-Pathogen Interactions:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
40 Methods and Protocols (Second Edition)"; Methods in Molecular Biology.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
41 Humana Press, Springer. In press.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
42
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
43 Whisson, S.C., Boevink, C.V., Moleleki, L., et al. (2007)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
44 A translocation signal for delivery of oomycete effector proteins into
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
45 host plant cells. Nature 450:115-118.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
46 http://dx.doi.org/10.1038/nature06203
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
47
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
48 Win, J., Morgan, W., Bos, J., et al. (2007)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
49 Adaptive evolution has targeted the C-terminal domain of the RXLR effectors
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
50 of plant pathogenic oomycetes. The Plant Cell 19:2349-2369.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
51 http://dx.doi.org/10.1105/tpc.107.051037
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
52
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
53 Bhattacharjee, S., Luisa Hiller, N., Liolios, K., et al. (2006)
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
54 The malarial host-targeting signal is conserved in the Irish potato famine
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
55 pathogen. PLoS Pathogens 2(5):e50.
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
56 http://dx.doi.org/10.1371/journal.ppat.0020050
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
57
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
58
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
59 Availability
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
60 ============
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
61
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
62 This workflow is available to download and/or install from the main
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
63 Galaxy Tool Shed:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
64
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
65 http://toolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
66
1a1ab2f2b5b5 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:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
68
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
69 http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
70
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
71 Development is being done on github here:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
72
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
73 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
74
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
75
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
76 Dependencies
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
77 ============
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
78
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
79 These dependencies should be resolved automatically via the Galaxy Tool Shed:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
80
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
81 * http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
82 * http://toolshed.g2.bx.psu.edu/view/peterjc/seq_filter_by_id
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
83 * http://toolshed.g2.bx.psu.edu/view/peterjc/venn_list
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
84
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
85 However, at the time of writing those Galaxy tools have their own dependencies
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
86 required for this workflow which require manual installation (SignalP v3.0,
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
87 HMMER v2.0, and the R/Bioconductor package limma).
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
88
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
89
4
3c280e01b920 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: 3
diff changeset
90 History
3c280e01b920 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: 3
diff changeset
91 =======
3c280e01b920 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: 3
diff changeset
92
3c280e01b920 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: 3
diff changeset
93 ======= ======================================================================
3c280e01b920 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: 3
diff changeset
94 Version Changes
3c280e01b920 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: 3
diff changeset
95 ------- ----------------------------------------------------------------------
3c280e01b920 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: 3
diff changeset
96 v0.0.1 - Initial release to Tool Shed (May, 2013)
3c280e01b920 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: 3
diff changeset
97 - Expanded README file to include example data
3c280e01b920 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: 3
diff changeset
98 v0.0.2 - Updated versions of the tools used, inclulding core Galaxy Filter
3c280e01b920 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: 3
diff changeset
99 tool to avoid warning about new ``header_lines`` parameter.
3c280e01b920 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: 3
diff changeset
100 - Added link to Tool Shed in the workflow annotation explaining there
3c280e01b920 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: 3
diff changeset
101 is a README file with sample data, and a requested citation.
3c280e01b920 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: 3
diff changeset
102 ======= ======================================================================
3c280e01b920 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: 3
diff changeset
103
3c280e01b920 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: 3
diff changeset
104
3
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
105 Developers
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
106 ==========
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
107
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
108 This workflow is under source code control here:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
109
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
110 https://github.com/peterjc/picobio/tree/master/galaxy_workflows/rxlr_venn_workflow
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
111
1a1ab2f2b5b5 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:
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
113
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
114 $ 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
115
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
116 Check this,
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
117
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
118 $ tar -tzf rxlr_venn_workflow.tar.gz
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
119 README.rst
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
120 repository_dependencies.xml
1a1ab2f2b5b5 README file with clearer citation instructions.
peterjc
parents:
diff changeset
121 rxlr_venn_workflow.ga