pageGuideVertical: Draw a vertical guideline at a specified x-coordinate on a...

View source: R/pageGuideVertical.R

pageGuideVerticalR Documentation

Draw a vertical guideline at a specified x-coordinate on a plotgardener page

Description

Draw a vertical guideline at a specified x-coordinate on a plotgardener page

Usage

pageGuideVertical(
    x,
    default.units = "inches",
    linecolor = "grey55",
    params = NULL,
    ...
)

Arguments

x

A numeric or unit object specifying x-coordinate of guide.

default.units

A string indicating the default units to use if x is only given as a numeric. Default value is default.units = "inches".

linecolor

Character value indicating color of guideline. Default value is linecolor = "grey55".

params

An optional pgParams object containing relevant function parameters.

...

Additional grid graphical parameters. See gpar.

Value

None.

Examples

## Create a page
pageCreate(width = 6, height = 5, default.units = "inches")

## Add blue vertical guideline at x = 1.7 inches
pageGuideVertical(x = 1.7, linecolor = "blue")

PhanstielLab/plotgardener documentation built on July 1, 2024, 7:06 p.m.