pageCreate: Create a page for a plotgardener layout

In PhanstielLab/BentoBox: Coordinate-Based Genomic Visualization Package for R

Create a page for a plotgardener layout

Description

Create a page for a plotgardener layout

Usage

pageCreate(
    width = 8.5,
    height = 11,
    default.units = "inches",
    bg = NA,
    xgrid = 0.5,
    ygrid = 0.5,
    showGuides = TRUE,
    params = NULL
)

Arguments

width	A numeric or unit object specifying page width. Default value is width = 8.
height	A numeric or unit object specifying page height. Default value is height = 11.
default.units	A string indicating the default units to use if width or height are only given as numerics. Default value is default.units = "inches".
bg	Character value indicating page background color. Default value is bg = NA.
xgrid	A numeric indicating the increment by which to place vertical gridlines. Default value is xgrid = 0.5.
ygrid	A numeric indicating the increment by which to place horizontal gridlines. Default value is ygrid = 0.5.
showGuides	A logical value indicating whether to draw a black border around the entire page and guiding rulers along the top and left side of the page. Default value is showOutline = TRUE.
params	An optional pgParams object containing relevant function parameters.

Details

width and height must be specified in the same units.

Value

None.

Examples

## Create a 6-inch wide, 4.5-inch high page
pageCreate(width = 6, height = 4.5, default.units = "inches")

## Create a 14-cm wide, 10-cm high page
pageCreate(width = 14, height = 10, default.units = "cm")

PhanstielLab/BentoBox documentation built on March 30, 2024, 3:46 a.m.