annotate readme.rst @ 12:46ddfceb1bb2 draft

Uploaded
author bgruening
date Wed, 30 Oct 2013 09:27:04 -0400
parents a68a771625d2
children 06311d89da81
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
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
28 ========
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
29 Citation
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
30 ========
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
31
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
32 deeptools are currently under review. In the meantime please refere to
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
33
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
34
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
35 =======
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
36 History
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
37 =======
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
38
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
39 - v1.0: Initial public release
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
40
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
41
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
42 ===============================
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
43 Wrapper Licence (MIT/BSD style)
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
44 ===============================
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
45
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
46 Permission to use, copy, modify, and distribute this software and its
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
47 documentation with or without modifications and for any purpose and
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
48 without fee is hereby granted, provided that any copyright notices
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
49 appear in all copies and that both those copyright notices and this
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
50 permission notice appear in supporting documentation, and that the
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
51 names of the contributors or copyright holders not be used in
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
52 advertising or publicity pertaining to distribution of the software
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
53 without specific prior permission.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
54
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
55 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
56 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
57 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
58 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
59 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
60 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
61 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
62 OR PERFORMANCE OF THIS SOFTWARE.
a68a771625d2 Uploaded
bgruening
parents:
diff changeset
63