annotate readme.rst @ 45:b9feca1f07f0 draft

Uploaded
author bgruening
date Mon, 31 Mar 2014 17:48:50 -0400
parents d0667be9cb0c
children b5abf7b4296b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
1 ========================
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
2 Galaxy deeptools wrapper
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
3 ========================
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
4
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
5 deepTools are user-friendly tools for the normalization and visualization of
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
6 deep-sequencing data.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
7 They address the challenge of visualizing the large amounts of data that are now
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
8 routinely generated from sequencing centers in a meaningful way.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
9 To do so, deepTools contain useful routines to process the mapped reads data
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
10 through removal of duplicates and different filtering options to create coverage
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
11 files in standard bedGraph and bigWig file formats. deepTools allow the creation
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
12 of normalized coverage files or the comparison between two files
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
13 (for example, treatment and control). Finally, using such normalized and
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
14 standardized files, multiple visualizations can be created to identify
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
15 enrichments with functional annotations of the genome.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
16 For a gallery of images that can be produced and a description
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
17 of the tools see our poster_.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
18
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
19 .. _poster: http://f1000.com/posters/browse/summary/1094053
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
20
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
21 deeptools is developed under here:
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
22
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
23 https://github.com/fidelram/deepTools
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
24
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
25 For support, questions, or feature requests contact: deeptools@googlegroups.com
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
26
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
27
45
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
28 ============
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
29 Installation
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
30 ============
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
31
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
32 Requirements: python-2.7
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
33
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
34 Galaxy should be able to automatically install all other dependencies, such as numpy or scipy.
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
35
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
36
b9feca1f07f0 Uploaded
bgruening
parents: 16
diff changeset
37
10
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
38 ========
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
39 Citation
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
40 ========
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
41
16
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
42 deeptools are currently under review. In the meantime please refere to https://github.com/fidelram/deepTools.
10
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
43
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
44
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
45 =======
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
46 History
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
47 =======
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
48
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
49 - v1.0: Initial public release
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
50
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
51
16
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
52 Licence (MIT)
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
53 =============
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
54
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
55 Permission is hereby granted, free of charge, to any person obtaining a copy
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
56 of this software and associated documentation files (the "Software"), to deal
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
57 in the Software without restriction, including without limitation the rights
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
58 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
59 copies of the Software, and to permit persons to whom the Software is
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
60 furnished to do so, subject to the following conditions:
10
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
61
16
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
62 The above copyright notice and this permission notice shall be included in
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
63 all copies or substantial portions of the Software.
10
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
64
16
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
65 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
66 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
67 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
68 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
69 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
70 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
d0667be9cb0c Uploaded
bgruening
parents: 14
diff changeset
71 THE SOFTWARE.