Skip to contents

Changelog

Source: NEWS.md

sessioncheck 0.2.0

Improvements

  • Formatted output (from print(), format(), and messages/warnings raised by action = "message"/"warn") is now nicer to read, with a cli-like style.

  • Messaging for sessioncheck() and the individual check_*() functions is more informative and more consistent across checkers, including a clearer distinction between “missing” and “mismatched” for the options/locale/sysenv checks, and a dedicated message for check_sessiontime() (#5).

New features

  • Added compare_sessionstates(), which reports how two sessionstate() snapshots differ – take a baseline snapshot, do some work, take another, and diff them. Returns an object of class sessioncheck_sessionstatediff with format(), print(), and as.data.frame() methods.

  • Added check_working_directory(), which checks the session’s working directory against an expected path (#11).

  • Added an action_on_pass argument to sessioncheck() and the individual check_*() functions, allowing a clean result to be confirmed with a message rather than remaining silent (#10).

  • Added sessionstate(), a companion to sessioncheck() intended for use at the end of a script as an audit log. It reports platform details (R version, OS, matrix products, locale, timezone, UI/frontend), selected machine information from Sys.info(), session timing, RNG state, and an inventory of attached and loaded-namespace packages, similar to sessioninfo::session_info(). Returns an object of class sessioncheck_sessionstate with format(), print(), and as.data.frame() methods.

Bug fixes

  • Fixed .get_locale_list() (used by check_required_locale()) to handle the case where Sys.getlocale() returns a single unprefixed value instead of the usual "CATEGORY=value;..." format, which happens when every locale category shares the same setting. Previously this caused every requested category to be misreported as missing.

sessioncheck 0.1.1

CRAN release: 2026-07-28

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 settings:” 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 unrecognized inputs.

  • Fixed sessioncheck() to validate the checks argument. Previously, unrecognized 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.

Testing

  • Added spelling to Suggests and added a spell-check test (tests/testthat/test-spelling.R) so that spelling::spell_check_package() runs automatically with devtools::test(). The test is skipped on CRAN.

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:

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