Checks the overall status of the R session — sessioncheck • sessioncheck

Individual session check functions that each inspect one way in which an R session could be considered not to be "clean". Session checkers can produce errors, warnings, or messages if requested.

Usage

sessioncheck(
  action = "warn",
  checks = c("globalenv_objects", "attached_packages", "attached_environments"),
  ...
)

Arguments

action: Behaviour to take if the status is not clean. Possible values are "error", "warn", "message", and "none". The default is action = "warn".
checks: Character vector listing the checks to run. The default is to run checks = c("globalenv_objects", "attached_packages", "attached_environments").
...: Arguments passed to individual checks.

Value

Invisibly returns an object of class sessioncheck_sessioncheck.

Details

sessioncheck() allows the user to apply multiple session checks in a single function. The following arguments are recognised 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()

Other arguments are ignored.

Examples

sessioncheck(action = "message")
#> Session check results:
#> - Objects in global environment: [no issues]
#> - Attached packages: sessioncheck
#> - Attached environments: [no issues]