OverviewPlot: Create heatmaps of segmentation values from a DNAcopy object.

Description Usage Arguments Details Author(s) Examples

Description

Creates color-based plots of the segmentation values from a provided DNAcopy object.

Usage

1
2
OverviewPlot(DNAcopy.object, samples, range.CNA = c(-2, 2), 
              color.palette = colorRampPalette(c("blue", "white", "red"))(49))

Arguments

DNAcopy.object

DNAcopy object with the segmentation values that need to be plotted.

samples

character vector with the names of the samples that need to be plotted. Names need to be as given in the DNAcopy object. This is an optional argument; all samples will be plotted by default.

range.CNA

the range of the segmentation values that will be plotted. Segmentation values outside of range.CNA will be capped to the minimum and maximum range.CNA values. This is an optional argument; the default range is c(-2, 2).

color.palette

the color palette that will be used for heatmaps. This is an optional argument; the default color palette is colorRampPalette(c("blue", "white", "red"))(49).

Details

OverviewPlot will print heatmaps of the segmentation values in a DNAcopy object. The samples argument can be used to limit the amount of plotted samples. The range.CNA vector determines where the segmentation values are capped and the range of segmentation values that is plotted. Finally, the color.palette argument can be used to create heatmaps with custom colors. All arguments except DNA.copy.object are optional.

Author(s)

Thomas Kuilman (t.kuilman@nki.nl)

Examples

1
2
3
4
5
6
## Generate heatmaps:

## Not run: OverviewPlot(segment.CNA.object) ## Plot using default settings.
## Not run: OverviewPlot(segment.CNA.object, samples = unique(segment.CNA.object$output$ID)[1:3]) ## Plot only first three samples in segment.CNA.object.
## Not run: OverviewPlot(segment.CNA.object, range.CNA = c(-1, 1)) ## Plot with values from -1 to 1 (outside of this range values are capped).
## Not run: OverviewPlot(segment.CNA.object, color.palette = colorRampPalette(c("blue", "white", "white", "red"))(49)) ## Plot with extra white in the middle of the color palette.

PeeperLab/Rtoolbox documentation built on May 8, 2019, 1:28 a.m.