processClipping: processClipping

In bernatgel/karyoploteR: Plot customizable linear genomes displaying arbitrary data

processClipping

Description

Sets image clipping if needed

Usage

processClipping(karyoplot, clipping, data.panel)

Arguments

karyoplot	(KaryoPlot) A KaryoPlot object representing the current plot
clipping	(logical) Wheter clipping should be activated or not
data.panel	(data panel identifier) The name of the data panel on which the plot should be allowed. Anything plotted outside it will be hidden (if clipping==TRUE and the plot is a zoom plot)

Details

Small utility function to help manage clipping. If the current plot is a zoomed plot and clipping is TRUE, activate the clip to the current data.panel. This will hide any plotting ocurring out of the data.panel region.

Value

Returns the original karyoplot object, unchanged.

Note

Users wont usually use this function. It is used by the plotting functions to set the clipping if needed

Examples

kp <- plotKaryotype()
processClipping(kp, TRUE, 1)

 

bernatgel/karyoploteR documentation built on Feb. 1, 2024, 11:48 p.m.