View source: R/evaluate.heterogeneity.R
evaluate.heterogeneity | R Documentation |
This tools evaluates what is the fraction of peaks covered by each sample provided in a peaks dataset obtained by merging all the peaks together or provided by the user. The peaks in the reference dataset are ranked by number of samples in which are present and average score all over the samples. This function uses the deeptools function multiBigwigSummary.
evaluate.heterogeneity(
bigWig.list,
peak.list,
labels = sub(pattern = "(.*)\\..*$", replacement = "\\1", basename(bigWig.list)),
reference.peaks = NULL,
distribution.line.color = "#1c30a3",
distribution.line.size = 1,
distribution.line.type = 1,
distribution.n.vertical.divisions = NULL,
distribution.as.percentage = F,
heatmap.color = "#1c30a3",
heatmap.zMax = NA,
heatmap.log1p.scale = TRUE,
bar.color = distribution.line.color,
widths.proportion = c(0.25, 1),
heights.proportion = c(1, 1),
min.percentage.reference = 0,
min.percentage.test = 0,
min.bases.overlap = 1,
multiBigWigSummary.path = "multiBigWigSummary"
)
bigWig.list |
A string vector with bigwig paths (same order than paths). |
peak.list |
A list of GRanges objects (not GRglist) or data.frames or a string vector with the path to bed files (same order than bigwigs). |
labels |
The labels to use for the samples (same order than bigwigs/peaks). Default: the basename of the bigWig.list. |
reference.peaks |
Default: |
distribution.line.color |
Color to use for the distribution line. Default: |
distribution.line.size |
Line size of the distribution plot. Default: |
distribution.line.type |
Line type of the distribution plot. Default: |
distribution.n.vertical.divisions |
Number of sectors in which divide the distribution plot (vertical lines will be plotted). Default: |
distribution.as.percentage |
Logical value to define whether the distribution plot should show percentage of sample coverage rather than number of samples. Default: |
heatmap.color |
Color to use for the heatmaps; a gradient from this color to white will be used. Default: |
heatmap.zMax |
Maximum of the heatmap scale. Default: |
heatmap.log1p.scale |
Logic value to define whether the heatmap scale should display log1p values. Default: |
bar.color |
Color to use for the barplot showing the fraction of reference peaks present in each sample. Default is to use the 'distribution.line.color'. |
widths.proportion |
Two-elements numeric vector to be passed to |
heights.proportion |
Two-elements numeric vector to be passed to |
min.percentage.reference |
Numeric value within 0-100 to define which percentage of 'reference' dataset must overlap with a 'sample'. If the value is lower than 0 or greater than 100, will be coerced to 0 or 100 respectively. Default value: |
min.percentage.test |
Numeric value within 0-100 to define which percentage of 'sample' datasets must overlap with a region in the 'reference' one. If the value is lower than 0 or greater than 100, will be coerced to 0 or 100 respectively. Default value: |
min.bases.overlap |
Integer, greater than 0, value to indicate the minimal number of bases to consider as minimum overlap between two regions. Non integer values will be rounded at integer, while number lower that 1 will be coerced to 1. Default value: |
multiBigWigSummary.path |
Path/command to run deeptools multiBigWigSummary tool. Default: |
To know more about the deepTools's function multiBigwigSummary
see the package manual at the following link:
https://deeptools.readthedocs.io/en/develop/content/tools/multiBigwigSummary.html.
The function returns a list containing:
metadata
: a list with the following elements
sample.id
: vector with the labels of the samples
bigWig.file
: string vector with the path to each bigwig file
bed.file
: list of peaks associated to each sample
n.peaks
: vector with number of peaks in each sample
count.matrix
: data.frame with presence (1) or absence (0) of each peak per each sample;
score.matrix
: data.frame with average score at each peak per each sample;
plot.list
: list of single separated plots: counts.distribution, fraction.peaks.per.sample, scores.heatmap;
multiplot
: the multiplot generated from the plot.list.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.