Skip to contents

Position scales for discrete marker data

Source: R/scale_marker.R
scale_marker_discrete.Rd

scale_marker_discrete() is used to set discrete x aesthetics for swimmer plot markers.

Usage

scale_marker_discrete(glyphs = NULL, colours = NULL, limits = NULL, ...)

Arguments

glyphs

Marker glyphs passed to the marker layer, taking on the form of emojis or ASCII shapes. Default glyphs are provided in the absence of defined ones.

colours

Marker colours passed to the marker layer for non-emojis. Default colours are provided in the absence of defined ones.

limits

One of:

  • NULL to use the default scale values

  • A character vector that defines possible values of the scale and their order

  • A function that accepts the existing (automatic) values and returns new ones. Also accepts rlang lambda function notation.

...

Arguments passed on to discrete_scale

palette

A palette function that when called with a single integer argument (the number of levels in the scale) returns the values that they should take (e.g., scales::pal_hue()).

breaks

One of:

  • NULL for no breaks

  • waiver() for the default breaks (the scale limits)

  • A character vector of breaks

  • A function that takes the limits as input and returns breaks as output. Also accepts rlang lambda function notation.

limits

One of:

  • NULL to use the default scale values

  • A character vector that defines possible values of the scale and their order

  • A function that accepts the existing (automatic) values and returns new ones. Also accepts rlang lambda function notation.

drop

Should unused factor levels be omitted from the scale? The default, TRUE, uses the levels that appear in the data; FALSE includes the levels in the factor. Please note that to display every level in a legend, the layer should use show.legend = TRUE.

na.translate

Unlike continuous scales, discrete scales can easily show missing values, and do so by default. If you want to remove missing values from a discrete scale, specify na.translate = FALSE.

na.value

If na.translate = TRUE, what aesthetic value should the missing values be displayed as? Does not apply to position scales where NA is always placed at the far right.

aesthetics

The names of the aesthetics that this scale works with.

labels

One of:

  • NULL for no labels

  • waiver() for the default labels computed by the transformation object

  • A character vector giving labels (must be same length as breaks)

  • An expression vector (must be the same length as breaks). See ?plotmath for details.

  • A function that takes the breaks as input and returns labels as output. Also accepts rlang lambda function notation.

call

The call used to construct the scale for reporting messages.

super

The super class to use for the constructed scale

Examples

if (FALSE) { # \dontrun{
all_events <- dplyr::bind_rows(
  infusion_events,
  end_study_events
)

ggplot2::ggplot() +
  geom_swim_marker(
    data = all_events,
    aes(x = time_from_initial_infusion, y = pt_id, marker = label),
    size = 5
  ) +
  scale_marker_discrete(
    glyphs = all_events$glyph,
    colours = all_events$colour,
    limits = all_events$label
  )
} # }