Mercurial > repos > bgruening > deeptools_plot_pca

comparison plotPCA.xml @ 32:94d2a13a344d 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 b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
author bgruening
date Thu, 15 Feb 2018 04:13:20 -0500
parents beb7f689a761
children 528355f62f3a
comparison
equal deleted inserted replaced
31:d4c7104427c5 32:94d2a13a344d
12 --plotTitle "$plotTitle" 12 --plotTitle "$plotTitle"
13 --plotFile "$outFileName" 13 --plotFile "$outFileName"
14 --plotFileFormat "$outFileFormat" 14 --plotFileFormat "$outFileFormat"
15 #if str($advancedOpt.showAdvancedOpt) == 'yes': 15 #if str($advancedOpt.showAdvancedOpt) == 'yes':
16 @PLOTWIDTHHEIGHT@ 16 @PLOTWIDTHHEIGHT@
17 $advancedOpt.log2
18 --PCs $advancedOpt.PCs
19 --ntop $advancedOpt.ntop
20 $advancedOpt.transpose
21 $advancedOpt.rowCenter
22 #if $advancedOpt.colors:
23 --colors $advancedOpt.colors
24 #end if
17 #end if 25 #end if
18 $rowCenter
19 #if $outFileNameData 26 #if $outFileNameData
20 --outFileNameData "$output_outFileNameData" 27 --outFileNameData "$output_outFileNameData"
21 #end if 28 #end if
22 ]]> 29 ]]>
23 </command> 30 </command>
24 <inputs> 31 <inputs>
25 <param name="corData" format="deeptools_coverage_matrix" type="data" label="Matrix file from the multiBamSummary or multiBigwigSummary tools"/> 32 <param name="corData" format="deeptools_coverage_matrix" type="data" label="Matrix file from the multiBamSummary or multiBigwigSummary tools"/>
26 <expand macro="input_image_file_format" /> 33 <expand macro="input_image_file_format" />
27 <expand macro="plotTitle" /> 34 <expand macro="plotTitle" />
28 <param argument="--outFileNameData" type="boolean" label="Save the matrix of PCA and eigenvalues underlying the plot."/> 35 <param argument="--outFileNameData" type="boolean" label="Save the matrix of PCA and eigenvalues underlying the plot."/>
29 <param argument="--rowCenter" type="boolean" label="Center Rows?" help="When specified, each row (bin, gene, etc.) in the matrix is centered at 0 before the PCA is computed. This is useful only if you have a strong bin/gene/etc. correlation and the resulting principal component has samples stacked vertically." truevalue="--rowCenter" falsevalue="" />
30 <conditional name="advancedOpt"> 36 <conditional name="advancedOpt">
31 <param name="showAdvancedOpt" type="select" label="Show advanced options" > 37 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
32 <option value="no" selected="true">no</option> 38 <option value="no" selected="true">no</option>
33 <option value="yes">yes</option> 39 <option value="yes">yes</option>
34 </param> 40 </param>
35 <when value="no" /> 41 <when value="no" />
36 <when value="yes"> 42 <when value="yes">
37 <expand macro="plotWidthHeight" PLOTWIDTH="5.0" PLOTHEIGHT="10.0" /> 43 <expand macro="plotWidthHeight" PLOTWIDTH="5.0" PLOTHEIGHT="10.0" />
44 <param name="PCs" argument="--PCs" label="Principal components to plot" value="1 2" type="text"
45 help="The principal components to plot. If specified, you must provide two different integers, greater than zero, separated by a space. An example (and the default) is '1 2'." />
46 <param name="ntop" argument="--ntop" label="Number of rows to use" value="1000" type="integer"
47 help="Use only the top N most variable rows in the original matrix. Specifying 0 will result in all rows being used. If the matrix is to be transposed, rows with 0 variance are always excluded, even if a values of 0 is specified. The default is 1000." />
48 <param name="log2" argument="--log2" type="boolean" truevalue="--log2" falsevalue="" label="log2 transform data" help="log2 transform the datapoints prior to computing the PCA. Note that 0.01 is added to all values to prevent 0 values from becoming -infinity. Using this option with input that contains negative values will result in an error." />
49 <param argument="--transpose" type="boolean" label="Transpose Matrix?" help="Perform the PCA on the transpose of the matrix, (i.e., with samples as rows and features/genes as columns). This then matches what is typically done in R for RNAseq data." truevalue="--transpose" falsevalue="" />
50 <param argument="--rowCenter" type="boolean" label="Center Rows?" help="When specified, each row (bin, gene, etc.) in the matrix is centered at 0 before the PCA is computed. This is useful only if you have a strong bin/gene/etc. correlation and the resulting principal component has samples stacked vertically. This option is not applicable if the PCA is performed on the transposed matrix." truevalue="--rowCenter" falsevalue="" />
51 <param argument="--colors" type="text" name="colors" label="Symbol colors" value="" optional="True"
52 help="A list of colors for the symbols. Color names and html hex string (e.g., #eeff22) are accepted. The color names should be space separated. For example, --colors 'red blue green'. If not specified, the symbols will be given automatic colors." />
38 </when> 53 </when>
39 </conditional> 54 </conditional>
40 </inputs> 55 </inputs>
41 <outputs> 56 <outputs>
42 <expand macro="output_image_file_format_not_nested" /> 57 <expand macro="output_image_file_format_not_nested" />
47 <tests> 62 <tests>
48 <test> 63 <test>
49 <param name="corData" value="multiBamSummary_result2b.npz" ftype="deeptools_coverage_matrix" /> 64 <param name="corData" value="multiBamSummary_result2b.npz" ftype="deeptools_coverage_matrix" />
50 <param name="plotTitle" value="Test Plot" /> 65 <param name="plotTitle" value="Test Plot" />
51 <param name="outFileFormat" value="png" /> 66 <param name="outFileFormat" value="png" />
52 <output name="outFileName" file="plotPCA_result1.png" ftype="png" compare="sim_size" delta="4000" /> 67 <param name="showAdvancedOpt" value="yes" />
68 <output name="outFileName" file="plotPCA_result1.png" ftype="png" compare="sim_size" delta="12000" />
53 </test> 69 </test>
54 <test> 70 <test>
55 <param name="corData" value="multiBamSummary_result2b.npz" ftype="deeptools_coverage_matrix" /> 71 <param name="corData" value="multiBamSummary_result2b.npz" ftype="deeptools_coverage_matrix" />
56 <param name="plotTitle" value="Test Plot" /> 72 <param name="plotTitle" value="Test Plot" />
57 <param name="outFileFormat" value="png" /> 73 <param name="outFileFormat" value="png" />
58 <param name="outFileNameData" value="True" /> 74 <param name="outFileNameData" value="True" />
59 <output name="outFileName" file="plotPCA_result2.png" ftype="png" compare="sim_size" delta="4000" /> 75 <output name="outFileName" file="plotPCA_result2.png" ftype="png" compare="sim_size" delta="12000" />
60 <output name="output_outFileNameData" file="plotPCA_result2.tabular" ftype="tabular" /> 76 <output name="output_outFileNameData" file="plotPCA_result2.tabular" ftype="tabular" />
61 </test> 77 </test>
62 </tests> 78 </tests>
63 <help> 79 <help>
64 <![CDATA[ 80 <![CDATA[
71 Output 87 Output
72 ------ 88 ------
73 89
74 The result is a panel of two plots: 90 The result is a panel of two plots:
75 91
76 1. The eigenvalues of the **top two principal components**. 92 1. Either the loadings (default) or the projections (``--transpose``) of the samples on the desired **two principal components**.
77 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 93 2. The **Scree plot** for principal components where the bars represent the eigenvalues the red line traces the amount of variability is explained by the individual components in a cumulative manner.
78 94
79 Example plot 95 Example plot
80 ------------ 96 ------------
81 97
82 .. image:: $PATH_TO_IMAGES/plotPCA_annotated.png 98 .. image:: $PATH_TO_IMAGES/plotPCA_annotated.png