diff --git a/R/set_blanket.R b/R/set_blanket.R index 1eccff9d5..786c2c2c8 100644 --- a/R/set_blanket.R +++ b/R/set_blanket.R @@ -16,12 +16,12 @@ #' @param annotation_linewidth A linewidth for `*_hline`/`*_vline`/`*_abline` and `*_curve`. Defaults to 0.33. #' @param annotation_family A family for `*_text` and `*_label`. Defaults to "". #' @param annotation_size A size for `*_text` and `*_label`. Defaults to 3.88. -#' @param col_palette_d For a discrete scale, a character vector of hex codes (or names) for the `col_palette`. -#' @param col_palette_c For a continuous scale, a character vector of hex codes (or names) for the `col_palette`. -#' @param col_palette_o For an ordinal scale, a `scales::pal_*()` function for the `col_palette`. -#' @param col_palette_na_d For a discrete scale, a hex code or name for the `col_palette_na`. -#' @param col_palette_na_c For a continuous scale, a hex code or name for the `col_palette_na`. -#' @param col_palette_na_o For an ordinal scale, a hex code or name for the `col_palette_na`. +#' @param col_palette_d For a discrete scale, a character vector of hex codes. +#' @param col_palette_c For a continuous scale, a character vector of hex codes. +#' @param col_palette_o For an ordinal scale, a `scales::pal_*()` function. +#' @param col_palette_na_d For a discrete scale, a hex code. +#' @param col_palette_na_c For a continuous scale, a hex code. +#' @param col_palette_na_o For an ordinal scale, a hex code. #' @param theme A ggplot2 theme that the `gg_*` function will add without side-effects. Note, `mode` takes precedence, unless `mode = NULL`. #' #' @return A globally set style. diff --git a/R/unweave.R b/R/unweave.R index 196cc77cf..bd39bdf46 100644 --- a/R/unweave.R +++ b/R/unweave.R @@ -1,5 +1,7 @@ #' Unweave geom defaults #' +#' @description Reset all updated geom defaults back to ggplot2 defaults. +#' #' @noRd unweave_geom_defaults <- function() { ggplot2::update_geom_defaults("area", NULL) diff --git a/R/weave.R b/R/weave.R index 04746d1e5..55c945bb5 100644 --- a/R/weave.R +++ b/R/weave.R @@ -23,7 +23,7 @@ weave_mode <- function(mode = light_mode_r()) { invisible(old) } -#' Set a theme +#' Set a theme (without side-effects) #' #' @description Set a theme to be `+`-ed on unmodified to `gg_*` functions. Note, `mode` takes precedence unless NULL. #' @@ -98,8 +98,8 @@ weave_geom_defaults <- function(colour = "#357BA2FF", #' Set a discrete colour palette #' -#' @param col_palette_d For a discrete scale, a character vector of hex codes (or col_palette_d_names) for the `col_palette_d`. -#' @param col_palette_d_na For a discrete scale, a hex code (or col_palette_d_name) for the `col_palette_d_col_palette_d_na`. +#' @param col_palette_d For a discrete scale, a character vector of hex codes. +#' @param col_palette_d_na For a discrete scale, a hex code. #' #' @export weave_col_palette_d <- function(col_palette_d = jumble, col_palette_d_na = "#CDC5BFFF") { @@ -146,8 +146,8 @@ weave_col_palette_d <- function(col_palette_d = jumble, col_palette_d_na = "#CDC #' Set a continuous colour palette #' -#' @param col_palette_c For a continuous scale, a character vector of hex codes (or col_palette_c_names) -#' @param col_palette_c_na For a continuous scale, a hex code (or col_palette_c_name) for the `col_palette_col_palette_c_na`. +#' @param col_palette_c For a continuous scale, a character vector of hex codes. +#' @param col_palette_c_na For a continuous scale, a hex code. #' #' @export weave_col_palette_c <- function(col_palette_c = viridisLite::mako(n = 9, direction = -1), @@ -185,8 +185,8 @@ weave_col_palette_c <- function(col_palette_c = viridisLite::mako(n = 9, directi #' Set an ordinal colour palette #' -#' @param col_palette_o For an ordicol_palette_o_nal scale, a `scales::pal_*()` function for the `col_palette_o`. -#' @param col_palette_o_na For an ordicol_palette_o_nal scale, a hex code (or col_palette_o_name) for the `col_palette_o_col_palette_o_na`. +#' @param col_palette_o For an ordinal scale, a `scales::pal_*()` function. +#' @param col_palette_o_na For an ordinal scale, a hex code. #' #' @export weave_col_palette_o <- function(col_palette_o = scales::pal_viridis(option = "G", direction = -1), diff --git a/man/set_blanket.Rd b/man/set_blanket.Rd index b79c73f78..c85e1ad8e 100644 --- a/man/set_blanket.Rd +++ b/man/set_blanket.Rd @@ -36,17 +36,17 @@ set_blanket( \item{annotation_size}{A size for \verb{*_text} and \verb{*_label}. Defaults to 3.88.} -\item{col_palette_d}{For a discrete scale, a character vector of hex codes (or names) for the \code{col_palette}.} +\item{col_palette_d}{For a discrete scale, a character vector of hex codes.} -\item{col_palette_na_d}{For a discrete scale, a hex code or name for the \code{col_palette_na}.} +\item{col_palette_na_d}{For a discrete scale, a hex code.} -\item{col_palette_c}{For a continuous scale, a character vector of hex codes (or names) for the \code{col_palette}.} +\item{col_palette_c}{For a continuous scale, a character vector of hex codes.} -\item{col_palette_na_c}{For a continuous scale, a hex code or name for the \code{col_palette_na}.} +\item{col_palette_na_c}{For a continuous scale, a hex code.} -\item{col_palette_o}{For an ordinal scale, a \verb{scales::pal_*()} function for the \code{col_palette}.} +\item{col_palette_o}{For an ordinal scale, a \verb{scales::pal_*()} function.} -\item{col_palette_na_o}{For an ordinal scale, a hex code or name for the \code{col_palette_na}.} +\item{col_palette_na_o}{For an ordinal scale, a hex code.} \item{theme}{A ggplot2 theme that the \verb{gg_*} function will add without side-effects. Note, \code{mode} takes precedence, unless \code{mode = NULL}.} } diff --git a/man/weave_col_palette_c.Rd b/man/weave_col_palette_c.Rd index c790c7e3f..34e4cb1f4 100644 --- a/man/weave_col_palette_c.Rd +++ b/man/weave_col_palette_c.Rd @@ -10,9 +10,9 @@ weave_col_palette_c( ) } \arguments{ -\item{col_palette_c}{For a continuous scale, a character vector of hex codes (or col_palette_c_names)} +\item{col_palette_c}{For a continuous scale, a character vector of hex codes.} -\item{col_palette_c_na}{For a continuous scale, a hex code (or col_palette_c_name) for the \code{col_palette_col_palette_c_na}.} +\item{col_palette_c_na}{For a continuous scale, a hex code.} } \description{ Set a continuous colour palette diff --git a/man/weave_col_palette_d.Rd b/man/weave_col_palette_d.Rd index 4feb9a0bb..faff5d13b 100644 --- a/man/weave_col_palette_d.Rd +++ b/man/weave_col_palette_d.Rd @@ -7,9 +7,9 @@ weave_col_palette_d(col_palette_d = jumble, col_palette_d_na = "#CDC5BFFF") } \arguments{ -\item{col_palette_d}{For a discrete scale, a character vector of hex codes (or col_palette_d_names) for the \code{col_palette_d}.} +\item{col_palette_d}{For a discrete scale, a character vector of hex codes.} -\item{col_palette_d_na}{For a discrete scale, a hex code (or col_palette_d_name) for the \code{col_palette_d_col_palette_d_na}.} +\item{col_palette_d_na}{For a discrete scale, a hex code.} } \description{ Set a discrete colour palette diff --git a/man/weave_col_palette_o.Rd b/man/weave_col_palette_o.Rd index 7c542a4d4..069ac5b43 100644 --- a/man/weave_col_palette_o.Rd +++ b/man/weave_col_palette_o.Rd @@ -10,9 +10,9 @@ weave_col_palette_o( ) } \arguments{ -\item{col_palette_o}{For an ordicol_palette_o_nal scale, a \verb{scales::pal_*()} function for the \code{col_palette_o}.} +\item{col_palette_o}{For an ordinal scale, a \verb{scales::pal_*()} function.} -\item{col_palette_o_na}{For an ordicol_palette_o_nal scale, a hex code (or col_palette_o_name) for the \code{col_palette_o_col_palette_o_na}.} +\item{col_palette_o_na}{For an ordinal scale, a hex code.} } \description{ Set an ordinal colour palette diff --git a/man/weave_theme.Rd b/man/weave_theme.Rd index e9682f60b..21067d9e6 100644 --- a/man/weave_theme.Rd +++ b/man/weave_theme.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/weave.R \name{weave_theme} \alias{weave_theme} -\title{Set a theme} +\title{Set a theme (without side-effects)} \usage{ weave_theme(theme = light_mode_r() + mode_orientation_to_x()) }