annotate readme.rst @ 8:1c5ed9126db6 draft

Uploaded
author bgruening
date Wed, 04 Dec 2013 05:50:46 -0500
parents c54d31467be4
children d2898b81b912
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
5
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
32 deeptools are currently under review. In the meantime please refere to https://github.com/fidelram/deepTools.
0
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
5
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
42 Licence (MIT)
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
43 =============
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
44
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
45 Permission is hereby granted, free of charge, to any person obtaining a copy
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
46 of this software and associated documentation files (the "Software"), to deal
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
47 in the Software without restriction, including without limitation the rights
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
48 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
49 copies of the Software, and to permit persons to whom the Software is
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
50 furnished to do so, subject to the following conditions:
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51
5
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
52 The above copyright notice and this permission notice shall be included in
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
53 all copies or substantial portions of the Software.
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54
5
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
55 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
56 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
57 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
58 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
59 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
60 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
c54d31467be4 Uploaded
bgruening
parents: 0
diff changeset
61 THE SOFTWARE.