Package {depguard}

depguard: Manifest-Based Dependency Conflict Detection for Sandboxed R Sessions

Description

depguard helps you catch R package version conflicts in sandboxed or ephemeral notebook environments (Kaggle, Colab, Binder) where a full renv lockfile workflow is impractical because you don't own or persist the environment.

Details

Two complementary modes:

• Manifest mode: declare the packages/versions you need with dep_manifest(), then verify the live environment (including transitive dependencies) with dep_check().

• Snapshot mode: capture a baseline with dep_snapshot() before an install, then use dep_diff() afterward to see what changed and whether it affects packages already loaded in your session.

dep_healthcheck() is a convenience entry point that picks the appropriate mode automatically.

Author(s)

Maintainer: Samruddhi Amol Shah samruddhi.bitnbyte@gmail.com

Authors:

• Samruddhi Amol Shah samruddhi.bitnbyte@gmail.com

• Kartik Patel kartikpatel.id@gmail.com

Other contributors:

• Amrit Pal amrit.pal@vit.ac.in [contributor]

See Also

Useful links:

• https://github.com/sunraycodes/depguard

• Report bugs at https://github.com/sunraycodes/depguard/issues

Check the live environment against a dependency manifest

Description

Walks the transitive dependency tree of each package declared in the manifest and compares installed versions against requirements. By default this is entirely local (reads installed package DESCRIPTION metadata) and makes no network calls, which matters in sandboxed notebooks with limited or no internet access.

Usage

dep_check(
  manifest = NULL,
  path = default_manifest_path(),
  recursive = TRUE,
  check_cran = FALSE
)

Arguments

Value

A data frame with columns package, required, installed, status ("ok", "mismatch", "missing"), depth ("direct"/"transitive"), and required_by.

Diff the current environment against a prior snapshot

Description

Compares package versions now against a snapshot taken earlier with dep_snapshot(), flagging anything that changed. Packages that changed and are still loaded in the current session are flagged as higher risk, since those are the ones most likely to cause silent downstream breakage.

Usage

dep_diff(snapshot)

Arguments

Value

A data frame with columns package, before, after, changed, currently_loaded, risk.

Roll back a single package to a specific version

Description

Reinstalls one package at a specific version, e.g. to undo a version that was silently pulled in as a side effect of another install. This performs a single-package rollback only — it does not resolve cascading conflicts that the rollback might introduce with other packages. For full dependency resolution, use renv::restore() or pak's solver instead.

Usage

dep_fix(package, version, method = c("pak", "remotes"))

Arguments

Details

Requires the remotes or pak package (listed in Suggests, not Imports, so depguard's core checking functions stay dependency-light).

Value

Invisibly, TRUE on success.

Examples

## Not run: 
dep_fix("stringr", "1.5.0")

## End(Not run)

Run a one-shot dependency health check

Description

Convenience entry point intended to be run at the top of a notebook session (e.g. on Kaggle or Colab). If a manifest exists (see dep_manifest()), checks the environment against it. Otherwise, falls back to reporting a plain snapshot of currently loaded package versions so you have a baseline to diff against later with dep_diff().

Usage

dep_healthcheck(path = default_manifest_path(), check_cran = FALSE)

Arguments

Value

Invisibly, either the result of dep_check() (if a manifest exists) or a depguard_snapshot object (if not).

Examples

dep_healthcheck()

Declare a dependency manifest

Description

Records the packages (and minimum versions) your project needs, so that dep_check() can later verify the live environment satisfies them. This is a lightweight alternative to a full renv lockfile, intended for sandboxed or ephemeral notebook sessions where you don't own or persist the environment.

Usage

dep_manifest(..., path = default_manifest_path())

Arguments

Value

Invisibly, the manifest as a named character vector.

Examples

tmp <- tempfile(fileext = ".rds")
dep_manifest(dplyr = "1.1.4", ggplot2 = "3.5.0", path = tmp)
unlink(tmp)

Read an existing dependency manifest

Description

Read an existing dependency manifest

Usage

dep_manifest_read(path = default_manifest_path())

Arguments

Value

A named character vector of package requirements, or NULL (invisibly) with a message if no manifest is found.

Snapshot currently loaded package versions

Description

Captures the versions of all currently loaded/attached packages, so a later call to dep_diff() can detect what an install silently changed. This is a thin wrapper around sessioninfo::session_info().

Usage

dep_snapshot()

Value

An object of class depguard_snapshot (invisibly printable), suitable for passing to dep_diff().

Examples

snap <- dep_snapshot()
dep_diff(snap)

Print a depguard snapshot

Description

Print a depguard snapshot

Usage

## S3 method for class 'depguard_snapshot'
print(x, ...)

Arguments

Value

The x object, returned invisibly.