Checks the overall status of the R session

sessioncheck() is the top-level orchestrator for this package's individual session checks: it runs one or more check_*() functions (e.g. check_attached_packages(), check_globalenv_objects()) in a single call and combines their results. Like the individual checks it wraps, it can produce errors, warnings, or messages if requested.

Usage

sessioncheck(action = NULL, checks = NULL, action_on_pass = NULL, ...)

Arguments

action

Behavior to take if the status is not clean. Possible values are "error", "warn", "message", and "none". If the user does not specify an action, the default is action = "warn".

checks

Character vector listing the checks to run. If the user does not specify the checks, the default is to run checks = c("globalenv_objects", "attached_packages", "attached_environments").

action_on_pass

Behavior to take if the status is clean. Possible values are "message" and "none". If the user does not specify a value, the default is action_on_pass = "none".

...

Arguments passed to individual checks.

Value

Invisibly returns an object of class sessioncheck_sessioncheck.

Details

The following arguments are recognized via ...:

• allow_globalenv_objects is passed to check_globalenv_objects()

• allow_attached_packages is passed to check_attached_packages()

• allow_attached_environments is passed to check_attached_environments()

• allow_loaded_namespaces is passed to check_loaded_namespaces()

• max_sessiontime is passed to check_sessiontime()

• required_options is passed to check_required_options()

• required_locale is passed to check_required_locale()

• required_sysenv is passed to check_required_sysenv()

• required_wd is passed to check_working_directory()

Other arguments are ignored.

See also

check_attached_packages(), check_loaded_namespaces(), check_globalenv_objects(), check_attached_environments(), check_sessiontime(), check_required_options(), check_required_locale(), check_required_sysenv(), check_working_directory()

Examples

sessioncheck(action = "message")
#> Session check results:
#> ✔ No unexpected objects in global environment
#> ✖ Unexpected packages: sessioncheck
#> ✔ No unexpected environments attached

# a session with nothing flagged by the default checks: `action` only
# controls what happens when a problem *is* found, so pass
# `action_on_pass = "message"` to confirm the clean result instead
sessioncheck(
  action = "none",
  allow_globalenv_objects = ls(envir = .GlobalEnv, all.names = TRUE),
  allow_attached_packages = .packages(),
  allow_attached_environments = search(),
  action_on_pass = "message"
)
#> Session check results:
#> ✔ No unexpected objects in global environment
#> ✔ No unexpected packages attached
#> ✔ No unexpected environments attached