Mercurial > repos > bgruening > deeptools_multi_bigwig_summary

comparison multiBigwigSummary.xml @ 0:bb542efec3b7 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 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
author bgruening
date Mon, 25 Jan 2016 20:19:55 -0500
parents
children 3da3c3750962
comparison
equal deleted inserted replaced
-1:000000000000 0:bb542efec3b7
1 <tool id="deeptools_multi_bigwig_summary" name="multiBigwigSummary" version="@WRAPPER_VERSION@.0">
2 <description>calculates average read coverages for a list of two or more bigwig files</description>
3 <macros>
4 <token name="@BINARY@">multiBigwigSummary</token>
5 <import>deepTools_macros.xml</import>
6 </macros>
7 <expand macro="requirements" />
8 <command>
9 <![CDATA[
10 #set files=[]
11 #set labels=[]
12
13 @multiple_input_bigwigs@
14
15 @BINARY@
16 $mode.modeOpt
17
18 @THREADS@
19
20 --outFileName $outFile
21 --bwfiles '#echo "' '".join($files)#'
22 --labels '#echo "' '".join($labels)#'
23
24 #if $outRawCounts:
25 --outRawCounts '$outFileRawCounts'
26 #end if
27
28 #if $mode.modeOpt == "bins":
29 --binSize '$mode.binSize'
30 --distanceBetweenBins '$mode.distanceBetweenBins'
31 #else:
32 --BED $mode.region_file
33 #end if
34
35 #if str($region.value) != '':
36 --region '$region'
37 #end if
38 ]]>
39 </command>
40
41 <inputs>
42 <expand macro="multiple_input_bigwigs" />
43
44 <conditional name="mode">
45 <param name="modeOpt" type="select" label="Choose computation mode"
46 help="In the bins mode, the correlation is computed using equally sized bins.
47 In the BED file mode, a list of genomic regions in BED format has to be given.
48 For each region in the BED file, the number of overlapping reads is counted in
49 each of the BigWig files. Then the correlation is computed.">
50 <option value="bins" selected="true">Bins</option>
51 <option value="BED-file">Limit correlation to certain regions (BED file)</option>
52 </param>
53 <when value="bins">
54 <param name="binSize" type="integer" value="10000" min="1"
55 label="Bin size in bp"
56 help="Length in bases for a window used to sample the genome. (--binSize)"/>
57
58 <expand macro="distanceBetweenBins" />
59 </when>
60 <when value="BED-file">
61 <param name="region_file" type="data" format="bed"
62 label="Region file in BED format"
63 help="Correlation is computed for the number of reads that overlap such regions."/>
64 </when>
65 </conditional>
66
67 <expand macro="region_limit_operation" />
68 <param argument="--outRawCounts" type="boolean" label="Save raw counts (coverages) to file" help=""/>
69
70 </inputs>
71 <outputs>
72 <data format="deeptools_coverage_matrix" name="outFile" label="${tool.name} on ${on_string}: correlation matrix" />
73 <data format="tabular" name="outFileRawCounts" label="${tool.name} on ${on_string}: bin counts">
74 <filter>outRawCounts is True</filter>
75 </data>
76 </outputs>
77 <tests>
78 <test>
79 <param name="bigwigfiles" value="test.bw,test.bw" ftype="bigwig" />
80 <param name="modeOpt" value="bins" />
81 <param name="binSize" value="10" />
82 <param name="corMethod" value="spearman" />
83 <output name="outFileName" file="multiBigwigSummary_result1.npz" ftype="deeptools_coverage_matrix" compare="sim_size" />
84 </test>
85 <!--test>
86 <param name="bigwigfiles" value="test.bw,test.bw" ftype="bigwig" />
87 <param name="modeOpt" value="BED-file" />
88 <param name="region_file" value="multiBamSummary_regions.bed" />
89 <param name="corMethod" value="pearson" />
90 <param name="outRawCounts" value="True" />
91 <output name="outFileRawCounts" file="multiBigwigSummary_result2.tabular" ftype="tabular" />
92 <output name="outFileName" file="multiBigwigSummary_result2.npz" ftype="deeptools_coverage_matrix" compare="sim_size" />
93 </test-->
94 </tests>
95 <help>
96 <![CDATA[
97 **What it does**
98
99 Given two or more bigWig files, multiBigwigSummary computes the average scores for each of the files in every genomic region.
100 This analysis is performed for the entire genome by running the program in 'bins' mode, or for certain user selected regions
101 in 'BED-file' mode. Typically the output of multiBigwigSummary is used by other tools, such as 'plotCorrelation' or 'plotPCA',
102 for visualization and diagnostic purposes.
103
104
105 **Output files**:
106
107 - **Coverage scores**: Coverage scores computed and saved in a format appropriate for 'plotCorrelation' or 'plotPCA'.
108
109 - Data matrix (optional,select to save raw counts to a file above): If you want to have a look at the coverage values
110 or compute statistics yourself using a different program (like R).
111
112 -----
113
114 @REFERENCES@
115 ]]>
116 </help>
117 <expand macro="citations" />
118 </tool>