Mercurial > repos > bgruening > deeptools_plot_pca

annotate readme.rst @ 20:aca788d8e71d draft

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