pageGuideHorizontal: Draw a horizontal guideline at a specified y-coordinate on a...

View source: R/pageGuideHorizontal.R

pageGuideHorizontalR Documentation

Draw a horizontal guideline at a specified y-coordinate on a plotgardener page

Description

Draw a horizontal guideline at a specified y-coordinate on a plotgardener page

Usage

pageGuideHorizontal(
    y,
    default.units = "inches",
    linecolor = "grey55",
    params = NULL,
    ...
)

Arguments

y

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

default.units

A string indicating the default units to use if y 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 red horizontal guideline at y = 2.5 inches
pageGuideHorizontal(y = 2.5, linecolor = "red")

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