Mercurial > repos > bgruening > deeptools_plot_pca
annotate plotPCA.xml @ 15:e8b8434f7125 draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 7150f0c106abd56920767518cc331ef6e4e7f439
author | bgruening |
---|---|
date | Thu, 18 Feb 2016 11:37:29 -0500 |
parents | 0a198e327cc1 |
children | 179b2441ae0b |
rev | line source |
---|---|
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
1 <tool id="deeptools_plot_pca" name="plotPCA" version="@WRAPPER_VERSION@.0"> |
13
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
2 <description>Generate principal component analysis (PCA) plots from multiBamSummary or multiBigwigSummary output</description> |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
3 <macros> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
4 <token name="@BINARY@">plotPCA</token> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
5 <import>deepTools_macros.xml</import> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
6 </macros> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
7 <expand macro="requirements"/> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
8 <command> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
9 <![CDATA[ |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
10 @BINARY@ |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
11 --corData "$corData" |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
12 --plotTitle "$plotTitle" |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
13 --plotFile "$outFileName" |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
14 --plotFileFormat "$outFileFormat" |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
15 ]]> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
16 </command> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
17 <inputs> |
11
f173cc2d28f9
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee
bgruening
parents:
9
diff
changeset
|
18 <param name="corData" format="deeptools_coverage_matrix" type="data" label="Matrix file from the multiBamSummary or multiBigwigSummary tools"/> |
3
1f9a7501bd38
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents:
0
diff
changeset
|
19 <expand macro="input_image_file_format" /> |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
20 <expand macro="plotTitle" /> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
21 </inputs> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
22 <outputs> |
3
1f9a7501bd38
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents:
0
diff
changeset
|
23 <expand macro="output_image_file_format_not_nested" /> |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
24 </outputs> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
25 <tests> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
26 <test> |
11
f173cc2d28f9
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee
bgruening
parents:
9
diff
changeset
|
27 <param name="corData" value="multiBamSummary_result2.npz" ftype="deeptools_coverage_matrix" /> |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
28 <param name="plotTitle" value="Test Plot" /> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
29 <param name="outFileFormat" value="png" /> |
15
e8b8434f7125
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 7150f0c106abd56920767518cc331ef6e4e7f439
bgruening
parents:
13
diff
changeset
|
30 <output name="outFileName" file="plotPCA_result1.png" ftpye="png" compare="sim_size" delta="4000" /> |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
31 </test> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
32 </tests> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
33 <help> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
34 <![CDATA[ |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
35 |
13
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
36 What it does |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
37 --------------- |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
38 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
39 This tool takes the **default output file of ``multiBamSummary``** or ``multiBigwigSummary`` to perform a principal component analysis (PCA). |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
40 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
41 Output |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
42 ------------- |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
43 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
44 The result is a panel of two plots: |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
45 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
46 1. The eigenvalues of the **top two principal components**. |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
47 2. The **Scree plot** for the top five principal components where the bars represent the amount of variability explained by the individual factors and the red line traces the amount of variability is explained by the individual components in a cumulative manner |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
48 |
13
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
49 Example plot |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
50 --------------- |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
51 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
52 .. image:: $PATH_TO_IMAGES/plotPCA_annotated.png |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
53 :width: 600 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
54 :height: 315 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
55 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
56 =================== |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
57 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
58 Background |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
59 ----------------- |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
60 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
61 Principal component analysis (PCA) can be used, for example, to determine whether **samples display greater variability** between experimental conditions than between replicates of the same treatment. PCA is also useful to identify unexpected patterns, such as those caused by batch effects or outliers. |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
62 Principal components represent the directions along which the variation in the data is maximal, so that the information (e.g., read coverage values) from thousands of regions can be represented by just a few dimensions. |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
63 |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
64 PCA is not necessarily meant to identify unknown groupings or clustering; it is up to the researcher to determine the experimental or technical reason underlying the principal components. |
0a198e327cc1
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents:
11
diff
changeset
|
65 |
0
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
66 |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
67 ----- |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
68 |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
69 @REFERENCES@ |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
70 ]]> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
71 </help> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
72 <expand macro="citations" /> |
a6fdea25d41f
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff
changeset
|
73 </tool> |