Changelog • sessioncheck

sessioncheck (development version)

Bug fixes

Fixed a broken roxygen2 comment in check_loaded_namespaces() that caused the first sentence of the @details help section to be silently dropped. The page previously opened mid-sentence with “(packages that have been loaded but not attached)…”; it now correctly reads “This checker inspects the list of loaded namespaces (packages that have been loaded but not attached)…”.
Fixed argument validation in sessioncheck() to run after merging the action argument with any value set via options(sessioncheck = ...). Previously, an invalid action supplied through options() bypassed validation entirely and produced a confusing error message (the session-check results) rather than a clear “invalid action” error.
Fixed a typo in the formatted output for locale check results: “Unexpected locale setttings:” is now “Unexpected locale settings:”.
Fixed a silent failure in check_required_options(), check_required_locale(), and check_required_sysenv() where an unnamed required_* list (e.g., required_options = list(0L)) caused all checks to be silently skipped. The required_* arguments now require a named list when non-empty, and passing an unnamed list is an error.
Fixed a latent bug in the internal .action() helper where passing a status object of an unexpected class left the variable is_ok undefined, causing an uninformative object 'is_ok' not found error. The function now uses else if branching and raises an explicit “unexpected status class” error for unrecognised inputs.
Fixed sessioncheck() to validate the checks argument. Previously, unrecognised check names (e.g. from a typo) were silently ignored; they now produce an error listing the valid check names.
Fixed a misleading mock in the sessioncheck() test suite: the mock for .get_locale_status() was returning a bare string instead of a sessioncheck_status object, making the associated assertion meaningless. The mock now returns a properly-constructed status object.

Documentation

Updated the DESCRIPTION to accurately reflect the full scope of the package. The previous description mentioned only the global environment and loaded namespaces; it now covers all eight check types (global environment, attached packages, loaded namespaces, attached environments, session run time, R options, locale settings, and system environment variables).
Fixed the @details section of check_attached_packages(), which referred to the parameter as allow rather than its correct name allow_attached_packages.
Fixed the @examples block of check_required_locale(), which passed required = list(...) instead of required_locale = list(...). The call worked only through R’s partial argument matching, which is fragile and misleading in documentation.
Removed self-referential links from the @seealso section of each check function. Each function previously listed itself among the “see also” links.

sessioncheck 0.1.0

Initial CRAN release. The package provides tools for checking whether an R session is in a clean state. The main user-facing functions are:

check_globalenv_objects() — flags unexpected objects in .GlobalEnv.
check_attached_packages() — flags non-base packages on the search path.
check_loaded_namespaces() — flags non-base loaded namespaces.
check_attached_environments() — flags non-package attachments on the search path.
check_sessiontime() — flags sessions that have been running longer than a threshold (default 300 seconds).
check_required_options() — flags R options that are absent or have unexpected values.
check_required_locale() — flags locale categories that have unexpected values.
check_required_sysenv() — flags system environment variables that are absent or have unexpected values.
sessioncheck() — a top-level orchestrator that runs multiple checks in a single call.

All check functions accept an action argument ("warn", "error", "message", or "none") and return an invisible sessioncheck_status object. Default behaviour and allowlists can be configured project-wide via options(sessioncheck = list(...)).