Mercurial > repos > bgruening > deeptools_compute_matrix_operations

annotate readme.rst @ 6:031a98a187c4 draft

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