annotate readme.rst @ 1:9d02cd7883ad draft

Uploaded
author bgruening
date Sat, 06 Jul 2013 10:04:23 -0400
parents 62c6da72dd4a
children 91f07ff056ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
1 ===============
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
2 Bismark Wrapper
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
3 ===============
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
4
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
5 Bismark_ uses Bowtie or Bowtie2 to map bisulfite converted sequence reads to a reference genome and determine cytosine methylation states.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
6
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
7 Publication: http://www.ncbi.nlm.nih.gov/pubmed/21493656
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
8
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
9 User Guide: http://www.bioinformatics.babraham.ac.uk/projects/bismark/Bismark_User_Guide_v0.7.12.pdf
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
10
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
11 .. _bismark: http://www.bioinformatics.babraham.ac.uk/projects/bismark/
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
12
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
13 Preparation
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
14 ===========
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
15
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
16 Create your reference index with *bismark_genome_preparation* in your normal Galaxy Bowtie2/Botwie index directory. It will create a Bisulfite_Genome folder directly in your Bowtie2/Bowtie index directory.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
17 If you follow that approach you do not need to specify or modify an extra .loc file.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
18 That wrapper will extract the path to the Bisulfite_Genome folder from ./tool-data/bowtie2_indices.loc or ./tool-data/bowtie_indices.loc.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
19
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
20 =======
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
21 History
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
22 =======
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
23
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
24 - v0.7: Initial public release
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
25 - v0.7.8: update and add Tool Shed Integration
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
26 - v0.7.11.1 change default output to BAM, from now on samtools are required
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
27 - v0.7.11.2 added multi-threading to samtools (samtools > 0.1.19 is required)
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
28 - v0.7.12 upgrade to bismark 0.7.12 and fix a major slowdown
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
29
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
30 ===============================
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
31 Wrapper Licence (MIT/BSD style)
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
32 ===============================
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
33
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
34 Permission to use, copy, modify, and distribute this software and its
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
35 documentation with or without modifications and for any purpose and
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
36 without fee is hereby granted, provided that any copyright notices
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
37 appear in all copies and that both those copyright notices and this
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
38 permission notice appear in supporting documentation, and that the
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
39 names of the contributors or copyright holders not be used in
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
40 advertising or publicity pertaining to distribution of the software
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
41 without specific prior permission.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
42
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
43 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
44 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
45 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
46 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
47 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
48 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
49 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
50 OR PERFORMANCE OF THIS SOFTWARE.
62c6da72dd4a Uploaded
bgruening
parents:
diff changeset
51