R/scribe-package.R

Defines functions .onAttach

# nolint start: line_length_linter.

#' @keywords internal
#' @importFrom methods new
#' @details For a quick overview, see `vignette("scribe")`
#' @section options:
#' \describe{
#'   \item{`scribe.flag.no`}{`[TRUE]`\cr Default value when `scribeArg` uses action `"flag"`}
#'   \item{`scribe.interactive`}{`[NULL]`\cr Controls `interactive()` check within internal `exit()`}
#' }
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL

# nolint end: line_length_linter.

op.scribe <- list( # nolint: object_name_linter.
  scribe.flag.no = TRUE,
  scribe.interactive = NULL,
  scribe.include = c("help", "version")
)

.onAttach <- function(libname, pkgname) {
  options(op.scribe[setdiff(names(op.scribe), names(options()))])
}

Try the scribe package in your browser

Any scripts or data that you put into this service are public.

scribe documentation built on Oct. 22, 2023, 1:18 a.m.