Skip to contents

Convenience helper for existing packages that already use albersdown and need to replace older vignette/site wiring with the latest defaults while choosing an Albers accent family and preset.

Usage

migrate_albersdown(
  path,
  family = "red",
  preset = c("homage", "study", "structural", "adobe", "midnight"),
  dry_run = FALSE
)

Arguments

path

Path to the package directory. Must be supplied explicitly; there is no default so that the function never writes to an unexpected location.

family

one of: "red","lapis","ochre","teal","green","violet"

preset

Visual preset (default "homage"). See albers_presets().

dry_run

if TRUE, report changes without writing files.

Value

TRUE invisibly.

Examples

# \donttest{
if (interactive()) {
  migrate_albersdown(path = ".", family = "teal", preset = "midnight", dry_run = TRUE)
}
# }