Skip to contents

Label pmplot aesthetics from a yspec object or named list

Source: R/pmp-gg-labs.R
pmp_gg_labs.Rd

This function generates x and y axis titles based on the data columns used to create the plot, looking up in a named list or yspec object. This is only for pmplot outputs; consider pm_gg_labs() for labeling aesthetics in an arbitrary gg object.

Usage

pmp_gg_labs(
  spec = list(),
  labs = list(),
  x = NULL,
  y = NULL,
  short_max = Inf,
  x_break = Inf,
  y_break = Inf,
  var_break = list(),
  ...
)

Arguments

spec

a named list of label data; names correspond to columns in the data used to make the plot; may also be a yspec object, which will be converted to a named list through yspec::ys_get_short_unit().

labs

another object like spec containing of label data to override names found in spec.

x

label for the x aesthetic; if NULL, resolved via the mapped column name. Pass a column name as a plain string to look it up in spec or labs; wrap in I() to use the string as a literal label.

y

label for the y aesthetic; see x.

short_max

passed to yspec::ys_get_short_unit() when spec is a yspec object.

x_break

character width at which to insert a single line break in the x axis label; defaults to Inf (no break); when the resolved label exceeds this width, a single newline is inserted at the last word boundary at or before the limit.

y_break

character width at which to insert a single line break in the y axis label; see x_break.

var_break

a named list or named numeric vector; names refer to variables in spec or labs, and each value is passed as the width argument to str_break() to insert a newline in that variable's label. Applied variable-by-variable before axis labels are resolved; keys absent from spec/labs are silently ignored.

...

additional arguments passed to ggplot2::labs().

Value

A pmp_gg_labs object that can be added to a pmplots gg object with +.

See also

pmp_relabel(), pmp_relabel_wrap(), pmp_relabel_pairs()

Examples

data <- pmplots_data_obs()

spec <- list(PRED = "Population predicted CX1123 (ng/mL)",
             DV = "Observed CX1123 (ng/mL)")

if (FALSE) { # \dontrun{
p <- dv_pred(data) + pmp_gg_labs(spec)

p
} # }