Mercurial > repos > bgruening > deeptools_multi_bigwig_summary
diff multiBigwigSummary.xml @ 1:3da3c3750962 draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
author | bgruening |
---|---|
date | Mon, 15 Feb 2016 10:28:51 -0500 |
parents | bb542efec3b7 |
children | 7b4732d497a3 |
line wrap: on
line diff
--- a/multiBigwigSummary.xml Mon Jan 25 20:19:55 2016 -0500 +++ b/multiBigwigSummary.xml Mon Feb 15 10:28:51 2016 -0500 @@ -1,5 +1,5 @@ <tool id="deeptools_multi_bigwig_summary" name="multiBigwigSummary" version="@WRAPPER_VERSION@.0"> - <description>calculates average read coverages for a list of two or more bigwig files</description> + <description>calculates average scores for a list of two or more bigwig files</description> <macros> <token name="@BINARY@">multiBigwigSummary</token> <import>deepTools_macros.xml</import> @@ -65,7 +65,7 @@ </conditional> <expand macro="region_limit_operation" /> - <param argument="--outRawCounts" type="boolean" label="Save raw counts (coverages) to file" help=""/> + <param argument="--outRawCounts" type="boolean" label="Save raw counts (scores) to file" help=""/> </inputs> <outputs> @@ -94,20 +94,27 @@ </tests> <help> <![CDATA[ -**What it does** + +What it does +-------------- -Given two or more bigWig files, multiBigwigSummary computes the average scores for each of the files in every genomic region. -This analysis is performed for the entire genome by running the program in 'bins' mode, or for certain user selected regions -in 'BED-file' mode. Typically the output of multiBigwigSummary is used by other tools, such as 'plotCorrelation' or 'plotPCA', -for visualization and diagnostic purposes. +This tool computes the average scores for every genomic region for every bigWig file that is provided. In principle, it does the same as ``multiBamSummary``, but for bigWig files. + +The analysis is performed for the entire genome by running the program in 'bins' mode, or for certain user selected regions (e.g., genes) in 'BED-file' mode. + +Typically the output of ``multiBigwigSummary`` is used by other tools, such as ``plotCorrelation`` or ``plotPCA``, for visualization and diagnostic purposes. -**Output files**: +Output +-------- + +The default output is a **compressed file** that can only be used with ``plotPCA`` or ``plotCorrelation``. -- **Coverage scores**: Coverage scores computed and saved in a format appropriate for 'plotCorrelation' or 'plotPCA'. +To analyze the average scores yourself, you can get the **uncompressed score matrix** where every row corresponds to a genomic region (or bin) and each column corresponds to a sample (BAM file). (To obtain this output file, select "Save raw counts (coverages) to file" ) -- Data matrix (optional,select to save raw counts to a file above): If you want to have a look at the coverage values - or compute statistics yourself using a different program (like R). +.. image:: $PATH_TO_IMAGES/multiBigwigSummary_output.png + :width: 600 + :height: 358 -----