annotate readme.rst @ 1:a22ccc261bb3 draft

Uploaded
author bgruening
date Fri, 15 Nov 2013 07:57:48 -0500
parents d957e25e18a3
children c54d31467be4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
1 ========================
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
2 Galaxy deeptools wrapper
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
3 ========================
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
4
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
5 deepTools are user-friendly tools for the normalization and visualization of
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
6 deep-sequencing data.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
7 They address the challenge of visualizing the large amounts of data that are now
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
8 routinely generated from sequencing centers in a meaningful way.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
9 To do so, deepTools contain useful routines to process the mapped reads data
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
10 through removal of duplicates and different filtering options to create coverage
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
11 files in standard bedGraph and bigWig file formats. deepTools allow the creation
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
12 of normalized coverage files or the comparison between two files
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
13 (for example, treatment and control). Finally, using such normalized and
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
14 standardized files, multiple visualizations can be created to identify
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
15 enrichments with functional annotations of the genome.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
16 For a gallery of images that can be produced and a description
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
17 of the tools see our poster_.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
18
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
19 .. _poster: http://f1000.com/posters/browse/summary/1094053
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
20
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
21 deeptools is developed under here:
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
22
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
23 https://github.com/fidelram/deepTools
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
24
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
25 For support, questions, or feature requests contact: deeptools@googlegroups.com
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
26
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
27
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
28 ========
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
29 Citation
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
30 ========
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
31
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
32 deeptools are currently under review. In the meantime please refere to
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
33
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
34
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
35 =======
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
36 History
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
37 =======
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
38
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
39 - v1.0: Initial public release
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
40
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
41
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
42 ===============================
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
43 Wrapper Licence (MIT/BSD style)
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
44 ===============================
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
45
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
46 Permission to use, copy, modify, and distribute this software and its
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
47 documentation with or without modifications and for any purpose and
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
48 without fee is hereby granted, provided that any copyright notices
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
49 appear in all copies and that both those copyright notices and this
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
50 permission notice appear in supporting documentation, and that the
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51 names of the contributors or copyright holders not be used in
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
52 advertising or publicity pertaining to distribution of the software
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
53 without specific prior permission.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
55 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
56 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
57 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
58 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
59 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
60 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
61 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
62 OR PERFORMANCE OF THIS SOFTWARE.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
63