annotate readme.rst @ 16:d9a0a017896a draft

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