document

Author: teunbrand

NAMESPACE

@@ -512,6 +512,8 @@ export(remove_missing)
 export(render_axes)
 export(render_strips)
 export(replace_theme)
+export(reset_geom_defaults)
+export(reset_stat_defaults)
 export(reset_theme_settings)
 export(resolution)
 export(scale_alpha)

R/geom-defaults.R

@@ -1,5 +1,7 @@
 #' Modify geom/stat aesthetic defaults for future plots
 #'
+#' Functions to update or reset the default aesthetics of geoms and stats.
+#'
 #' @param stat,geom Name of geom/stat to modify (like `"point"` or
 #'   `"bin"`), or a Geom/Stat object (like `GeomPoint` or
 #'   `StatBin`).
@@ -17,9 +19,11 @@
 #' GeomPoint$default_aes
 #' ggplot(mtcars, aes(mpg, wt)) + geom_point()
 #'
-#' # reset default
+#' # reset single default
 #' update_geom_defaults("point", NULL)
 #'
+#' # reset all defaults
+#' reset_geom_defaults()
 #'
 #' # updating a stat's default aesthetic settings
 #' # example: change stat_bin()'s default y-axis to the density scale
@@ -30,9 +34,12 @@
 #'   geom_histogram() +
 #'   geom_function(fun = dnorm, color = "red")
 #'
-#' # reset default
+#' # reset single default
 #' update_stat_defaults("bin", NULL)
 #'
+#' # reset all defaults
+#' reset_stat_defaults()
+#'
 #' @rdname update_defaults
 update_geom_defaults <- function(geom, new) {
   update_defaults(geom, "Geom", new, env = parent.frame())
@@ -44,8 +51,12 @@ update_stat_defaults <- function(stat, new) {
   update_defaults(stat, "Stat", new, env = parent.frame())
 }
 
+#' @rdname update_defaults
+#' @export
 reset_geom_defaults <- function() reset_defaults("geom")
 
+#' @rdname update_defaults
+#' @export
 reset_stat_defaults <- function() reset_defaults("stat")
 
 cache_defaults <- new_environment()