l_getLocations: For the target compound loon plot, determines location (only...

In loon: Interactive Statistical Data Visualization

For the target compound loon plot, determines location (only and excluding the grobs) arguments to pass to 'gridExtra::arrangeGrob()'

Description

For the target compound loon plot, determines location (only and excluding the grobs) arguments to pass to 'gridExtra::arrangeGrob()'

Usage

l_getLocations(target)

## S3 method for class 'l_facet'
l_getLocations(target)

## S3 method for class 'l_pairs'
l_getLocations(target)

## S3 method for class 'l_ts'
l_getLocations(target)

Arguments

target

the (compound) loon plot whose locations are needed lay it out.

Value

a list of an appropriate subset of the named location arguments 'c("ncol", "nrow", "layout_matrix", "heights", "widths")'. There are as many heights and widths as there are plots returned by l_getPlots(); these specify the relative height and width of each plot in the display. layout_matrix is an nrow by ncol matrix whose entries identify the location of each plot in l_getPlots() by their index.

Examples

if(interactive()) {

pp <- l_pairs(iris, showHistograms = TRUE)
ll <- l_getLocations(pp)
nplots <- length(l_getPlots(pp))
# the plots returned by l_getPlots(pp) are positioned
# in order by the layout_matrix
ll$layout_matrix
}

loon documentation built on July 9, 2023, 5:48 p.m.