# HG changeset patch # User bgruening # Date 1391453075 18000 # Node ID 5ea8782d650c2077320675123691557c073d0c69 # Parent ef65d6b68ccc75623f43b1e08e2d92313e4e5085 Uploaded diff -r ef65d6b68ccc -r 5ea8782d650c bamCompare.xml --- a/bamCompare.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/bamCompare.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + normalizes and compares two BAM files to obtain the ratio, log2ratio or difference. (bam2bigwig) + bamCompare deepTools_macros.xml @@ -36,19 +37,25 @@ #if $comparison.normalization.type=='rpkm': --normalizeUsingRPKM #elif $comparison.normalization.type=='1x': - --normalizeTo1x $comparison.normalization.normalizeTo1x + + #if $comparison.normalization.effectiveGenomeSize.effectiveGenomeSize_opt == "specific": + --normalizeTo1x $comparison.normalization.effectiveGenomeSize.effectiveGenomeSize + #else: + --normalizeTo1x $comparison.normalization.effectiveGenomeSize.effectiveGenomeSize_opt + #end if + #end if #end if + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": #if $advancedOpt.smoothLength: --smoothLength '$advancedOpt.smoothLength' #end if - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if - $advancedOpt.doNotExtendPairedEnds $advancedOpt.ignoreDuplicates @@ -122,9 +129,7 @@ - + @@ -135,6 +140,8 @@ + + @@ -147,10 +154,6 @@ label="Smooth values using the following length (in bp)" help ="The smooth length defines a window, larger than the bin size, to average the number of reads. For example, if the bin size is set to 20 bp and the smooth length is set to 60 bp, then, for each bin size the average of it and its left and right neighbors is considered. Any value smaller than the bin size will be ignored and no smoothing will be applied."/> - - @@ -202,13 +205,18 @@ .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png +You can find more details in the `bamCompare wiki`_. + +.. _bamCompare wiki: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCompare + + **Output files**: - same as for bamCoverage, except that you now obtain 1 coverage file that is based on 2 BAM files. ----- -.. class:: infomark +@REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c bamCorrelate.xml --- a/bamCorrelate.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/bamCorrelate.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + correlates pairs of BAM files + bamCorrelate deepTools_macros.xml @@ -39,12 +40,12 @@ --BED $mode.region_file #end if - ## options available in both modes - #if $mode.advancedOpt.showAdvancedOpt == "yes": + #### options available in both modes + #if str($mode.region.value) != '': + --region '$mode.region' + #end if - #if str($mode.advancedOpt.region.value) != '': - --region '$mode.advancedOpt.region' - #end if + #if $mode.advancedOpt.showAdvancedOpt == "yes": $mode.advancedOpt.doNotExtendPairedEnds $mode.advancedOpt.ignoreDuplicates @@ -149,18 +150,19 @@ :alt: Heatmap of RNA Polymerase II ChIP-seq +You can find more details in the `bamCorrelate wiki`_. + +.. _bamCorrelate wiki: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCompare + + **Output files**: - diagnostic plot produced by bamCorrelate is a clustered heatmap displaying the values for each pair-wise correlation, see below for an example - data matrix (optional) in case you want to plot the correlation values using a different program, e.g. R, this matrix can be used - - ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c bamCoverage.xml --- a/bamCoverage.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/bamCoverage.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + generates a coverage bigWig file from a given BAM file. Multiple options are available to count reads and normalize coverage. (bam2bigwig) + bamCoverage deepTools_macros.xml @@ -21,19 +22,24 @@ #if $scaling.type=='rpkm': --normalizeUsingRPKM #elif $scaling.type=='1x': - --normalizeTo1x $scaling.normalizeTo1x + #if $scaling.effectiveGenomeSize.effectiveGenomeSize_opt == "specific": + --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize + #else: + --normalizeTo1x $scaling.effectiveGenomeSize.effectiveGenomeSize_opt + #end if #elif $scaling.type=='own': --scaleFactor $scaling.scaleFactor #end if + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": #if $advancedOpt.smoothLength: --smoothLength '$advancedOpt.smoothLength' #end if - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if $advancedOpt.doNotExtendPairedEnds $advancedOpt.ignoreDuplicates @@ -70,9 +76,7 @@ - + bedgraph + + @@ -96,10 +102,6 @@ label="Smooth values using the following length (in bp)" help ="The smooth length defines a window, larger than the bin size, to average the number of reads. For example, if the bin size is set to 20 bp and the smooth length is set to 60 bp, then, for each bin size the average of it and its left and right neighbors is considered. Any value smaller than the bin size will be ignored and no smoothing will be applied."/> - - @@ -140,14 +142,17 @@ .. image:: $PATH_TO_IMAGES/norm_IGVsnapshot_indFiles.png +You can find more details in the `bamCoverage wiki`_. + +.. _bamCoverage wiki: https://github.com/fidelram/deepTools/wiki/Normalizations#wiki-bamCoverage + + **Output files**: - coverage file either in bigWig or bedGraph format ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c bamFingerprint.xml --- a/bamFingerprint.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/bamFingerprint.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + plots profiles of BAM files; useful for assesing ChIP signal strength + bamFingerprint deepTools_macros.xml @@ -29,12 +30,11 @@ --plotFileFormat 'png' #end if + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": - - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if - --binSize '$advancedOpt.binSize' --numberOfSamples '$advancedOpt.numberOfSamples' @@ -53,8 +53,12 @@ + + + + @@ -62,10 +66,6 @@ - - @@ -133,6 +133,11 @@ .. image:: $PATH_TO_IMAGES/QC_fingerprint.png +You can find more details in the `bamFingerprint wiki`_. + +.. _bamFingerprint wiki: https://github.com/fidelram/deepTools/wiki/QC#wiki-bamFingerprint + + **Output files**: - Diagnostic plot @@ -140,8 +145,6 @@ ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c bigwigCompare.xml --- a/bigwigCompare.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/bigwigCompare.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + normalizes and compares two bigWig files to obtain the ratio, log2ratio or difference + bigwigCompare deepTools_macros.xml @@ -18,10 +19,11 @@ --ratio $comparison_type + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if --missingDataAsZero $advancedOpt.missingDataAsZero --scaleFactors '$advancedOpt.scaleFactor1:$advancedOpt.scaleFactor2' @@ -49,6 +51,8 @@ + + @@ -60,10 +64,6 @@ label="Bin size in bp" help="Size of the bins in bp for the ouput of the bigwig/bedgraph file "/> - - @@ -93,10 +93,9 @@ finally a summarizing value is reported. This value can be the ratio of the number of reads per bin, the log2 of the ratio, the sum or the difference. + ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c computeGCBias.xml --- a/computeGCBias.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/computeGCBias.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + to see whether your samples should be normalized for GC bias + computeGCBias deepTools_macros.xml @@ -24,10 +25,11 @@ --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt #end if + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if --sampleSize '$advancedOpt.sampleSize' --regionSize '$advancedOpt.regionSize' @@ -56,6 +58,9 @@ + + + @@ -63,10 +68,6 @@ - - @@ -131,6 +132,11 @@ .. image:: $PATH_TO_IMAGES/QC_GCplots_input.png +You can find more details in the `computeGCBias wiki`_. + +.. _computeGCBias wiki: https://github.com/fidelram/deepTools/wiki/QC#wiki-computeGCbias + + **Output files**: - Diagnostic plot @@ -145,8 +151,6 @@ ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c computeMatrix.xml --- a/computeMatrix.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/computeMatrix.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + summarizes and prepares an intermediary file containing scores associated with genomic regions that can be used afterwards to plot a heatmap or a profile + computeMatrix deepTools_macros.xml @@ -51,8 +52,8 @@ --afterRegionStartLength $mode.afterRegionStartLength #else --regionBodyLength $mode.regionBodyLength - --startLabel $mode.startLabel - --endLabel $mode.endLabel + --startLabel "$mode.startLabel" + --endLabel "$mode.endLabel" #if $mode.regionStartLength.regionStartLength_select == "yes": --beforeRegionStartLength $mode.regionStartLength.beforeRegionStartLength --afterRegionStartLength $mode.regionStartLength.afterRegionStartLength @@ -100,18 +101,17 @@ - - - - - - - - - - - - + + + + + + + + + + + @@ -208,9 +208,12 @@ :alt: Relationship between computeMatrix, heatmapper and profiler ------ +You can find more details in the `computeMatrix wiki`_. -.. class:: infomark +.. _computeMatrix wiki: https://github.com/fidelram/deepTools/wiki/Visualizations#wiki-computeMatrix + + +----- @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c correctGCBias.xml --- a/correctGCBias.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/correctGCBias.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + uses the output from computeGCBias to generate corrected BAM files + correctGCBias deepTools_macros.xml @@ -32,15 +33,17 @@ --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt #end if + #if str(region).strip() != '': + --region 'region' + #end if + #if $advancedOpt.showAdvancedOpt == "yes": - #if str($advancedOpt.region.value) != '': - --region '$advancedOpt.region' - #end if --binSize '$advancedOpt.binSize' #end if - #set newoutFileName="corrected."+str($outFileFormat) - --correctedFile $newoutFileName; + ###set newoutFileName="corrected."+str($outFileFormat) + ##--correctedFile $newoutFileName; + --correctedFile "corrected.bam"; mv $newoutFileName $outFileName @@ -50,11 +53,14 @@ + + @@ -63,10 +69,6 @@ - - @@ -75,11 +77,11 @@ - + @@ -89,14 +91,18 @@ This tool requires the output from computeGCBias to correct the given BAM files according to the method proposed by Benjamini and Speed (2012). Nucleic Acids Res. The resulting BAM files can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on. + +You can find more details in the `correctGCBias wiki`_. + +.. _correctGCBias wiki: https://github.com/fidelram/deepTools/wiki/QC#wiki-correctGCbias + + **Output files**: - GC-normalized BAM file ----- -.. class:: infomark - @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c deepTools_macros.xml --- a/deepTools_macros.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/deepTools_macros.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,5 +1,8 @@ + + + @@ -7,10 +10,6 @@ - - @@ -37,13 +36,21 @@ + + + + + --numberOfProcessors "\${GALAXY_SLOTS:-4}" + @BINARY@ samtools deepTools ucsc_tools - deepTools + deepTools ucsc_tools numpy pysam @@ -53,7 +60,45 @@ bx-python + @BINARY@ --version + + + + + + + + + + + + + + + + + + + + + + + + + + #if $advancedOpt.used_multiple_regions.used_multiple_regions_options == 'no': + #if $advancedOpt.used_multiple_regions.clustering.clustering_options == 'kmeans': + #if int($advancedOpt.used_multiple_regions.clustering.k_kmeans) > 0: + --kmeans $advancedOpt.used_multiple_regions.clustering.k_kmeans + #end if + #end if + #end if + + @@ -66,7 +111,9 @@ -For more informations, please visit our `project site`_. +.. class:: infomark + +For more informations, please visit the `project site`_. If you would like to give us feedback or you run into any trouble, please send an email to deeptools@googlegroups.com @@ -75,7 +122,7 @@ .. _Bioinformatics and Deep-Sequencing Unit: http://www3.ie-freiburg.mpg.de/facilities/research-facilities/bioinformatics-and-deep-sequencing-unit/ .. _Max Planck Institute for Immunobiology and Epigenetics: http://www3.ie-freiburg.mpg.de -.. _project site: https://github.com/fidelram/deepTools +.. _project site: https://github.com/fidelram/deepTools/wiki/ @@ -146,15 +193,19 @@ help="The effective genome size is the portion of the genome that is mappable. Large fractions of the genome are stretches of NNNN that should be discarded. Also, if repetitive regions were not included in the mapping of reads, the effective genome size needs to be adjusted accordingly. See Table 2 of http://www.plosone.org/article/info%3Adoi%2F10.1371%2Fjournal.pone.0030377 or http://www.nature.com/nbt/journal/v27/n1/fig_tab/nbt.1518_T1.html for several effective genome sizes."> - - - - + + + + + + + + diff -r ef65d6b68ccc -r 5ea8782d650c heatmapper.xml --- a/heatmapper.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/heatmapper.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,8 +1,9 @@ - + creates a heatmap for a score associated to genomic regions + heatmapper deepTools_macros.xml @@ -80,13 +81,7 @@ $advancedOpt.onePlotPerGroup - #if $advancedOpt.used_multiple_regions.used_multiple_regions_options == 'yes': - #if $advancedOpt.used_multiple_regions.clustering.clustering_options == 'kmeans': - #if int($advancedOpt.used_multiple_regions.clustering.k_kmeans) > 0: - --kmeans $advancedOpt.used_multiple_regions.clustering.k_kmeans - #end if - #end if - #end if + @kmeans_clusterin@ #end if @@ -147,7 +142,6 @@ - @@ -171,28 +165,8 @@ label="Do one plot per group" help="When computeMatrix was used on more than one group of genes, the average plots for all the groups will be drawn in one panel by default. If this option is set, each group will get its own plot, stacked on top of each other."/> - - - - - - - - - - - - - - - - - - - + + @@ -224,9 +198,12 @@ :alt: Heatmap of RNA Polymerase II ChIP-seq ------ +You can find more details in the `heatmapper wiki`_. -.. class:: infomark +.. _heatmapper wiki: https://github.com/fidelram/deepTools/wiki/Visualizations#wiki-heatmapper + + +----- @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c profiler.xml --- a/profiler.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/profiler.xml Mon Feb 03 13:44:35 2014 -0500 @@ -1,10 +1,11 @@ - + creates a profile plot for a score associated to genomic regions + profiler deepTools_macros.xml @@ -42,10 +43,14 @@ --regionsLabel '$advancedOpt.regionsLabel' - #if str($advancedOpt.plotTitle.value) != "None": + #if str($advancedOpt.plotTitle).strip() != "": --plotTitle '$advancedOpt.plotTitle' #end if + #if str($advancedOpt.colors).strip() != "": + --colors #echo ' '.join( ["'%s'" % $color for $color in $advancedOpt.colors.split()] )# + #end if + $advancedOpt.onePlotPerGroup #if $advancedOpt.yMin: @@ -59,6 +64,9 @@ #if str($advancedOpt.yAxisLabel.value) != "None": --yAxisLabel '$advancedOpt.yAxisLabel' #end if + + @kmeans_clusterin@ + #end if @@ -101,19 +109,26 @@ label="Plot width" help="Width in cm. The default value is 8 centimeters. The minimum value is 1 cm." /> + help="For the summary plot (profile) only. The "lines" option will plot the profile line based on the average type selected. The "fill" option fills the region between zero and the profile curve. The fill in color is semi transparent to distinguish different profiles. The "add standard error" option colors the region between the profile and the standard error of the data. As in the case of fill, a semi-transparent color is used. The option "overlapped_lines" plots each region values, one on top of the other; this option only works if "one plot per proup" is set."> - + + + all(c in ' #abcdefghijklmnopqrstuvwxyz0123456789' for c in value) + + + + + @@ -137,9 +152,12 @@ :alt: Meta-gene profile of Rna Polymerase II ------ +You can find more details in the `profiler wiki`_. -.. class:: infomark +.. _profiler wiki: https://github.com/fidelram/deepTools/wiki/Visualizations#wiki-profiler + + +----- @REFERENCES@ diff -r ef65d6b68ccc -r 5ea8782d650c tool_dependencies.xml --- a/tool_dependencies.xml Sat Dec 21 14:26:06 2013 -0500 +++ b/tool_dependencies.xml Mon Feb 03 13:44:35 2014 -0500 @@ -57,7 +57,7 @@ The tools downloaded by this dependency definition are free for academic use. TODO: UCSC tools are only available with their latest version. That is not good for reproducibility. - + git clone --recursive https://github.com/fidelram/deepTools.git @@ -79,7 +79,7 @@ - git reset --hard e5c75f3e967be0fa1d6dbcbb63a0f992e1cdcd61 + git reset --hard 1093b2d281576f23ee04740bd5eae3f7b8422f7e $INSTALL_DIR/lib/python export PYTHONPATH=$PYTHONPATH:$INSTALL_DIR/lib/python &&