WIP: Export pillar_options

NAMESPACE

@@ -129,6 +129,7 @@ export(num)
 export(obj_sum)
 export(pillar)
 export(pillar_component)
+export(pillar_options)
 export(pillar_shaft)
 export(set_char_opts)
 export(set_num_opts)

R/options.R

@@ -2,30 +2,37 @@
 #'
 #' Options that affect display of tibble-like output.
 #'
-#' These options can be set via [options()] and queried via [getOption()].
-#' For this, add a `pillar.` prefix (the package name and a dot) to the option name.
-#' Example: for an option `foo`, use `options(pillar.foo = value)` to set it
-#' and `getOption("pillar.foo")` to retrieve the current value.
-#' An option value of `NULL` means that the default is used.
+#' All options are available via the `pillar_options` list.
+#' The elements of this list are combined getter/setter functions.
+#' Calling a function without arguments returns the current value,
+#' by providing an argument the current value is set and the old value
+#' is returned, invisibly.
+#' Setting `local = TRUE` enables the option for the duration of the
+#' current stack frame via [rlang::local_options()].
 #'
-#' @format NULL
+#' These options can also be set via [options()] and queried via [getOption()].
+#' For this, add a `pillar.` prefix (the package name and a dot) to the option name.
+#' Example: for an option `foo`,
+#' `pillar_options$foo(value)` is equivalent to
+#' `options(pillar.foo = value)`.
 #'
+#' @export
 #' @examples
 #' # Default setting:
-#' getOption("pillar.sigfig")
+#' pillar_options$sigfig()
 #' pillar(1.234567)
 #'
 #' # Change for the duration of the session:
-#' old <- options(pillar.sigfig = 6)
+#' old <- pillar_options$sigfig(6)
 #' pillar(1.234567)
 #'
 #' # Change back to the original value:
-#' options(old)
+#' pillar_options$sigfig(old)
 #' pillar(1.234567)
 #'
 #' # Local scope:
 #' local({
-#'   rlang::local_options(pillar.sigfig = 6)
+#'   pillar_options$sigfig(6, local = TRUE)
 #'   pillar(1.234567)
 #' })
 #' pillar(1.234567)

_pkgdown.yml

@@ -79,6 +79,7 @@ navbar:
 
 development:
   mode: auto
+  destination: options
 
 authors:
   Kirill Müller: