Get a Situation Report on System, nflverse Package Versions and Dependencies
Source:R/report.R
report.Rd
This function gives a quick overview of the versions of R and the operating system as well as the versions of nflverse packages, options, and their dependencies. It's primarily designed to help you get a quick idea of what's going on when you're helping someone else debug a problem.
Arguments
- ...
Arguments passed on to
nflreadr::nflverse_sitrep
pkg
a character vector naming installed packages, or
NULL
(the default) meaning all nflverse packages. The function checks internally if all packages are installed and informs if that is not the case.recursive
a logical indicating whether dependencies of
pkg
and their dependencies (and so on) should be included. Can also be a character vector listing the types of dependencies, a subset ofc("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")
. Character string"all"
is shorthand for that vector, character string"most"
for the same vector without"Enhances"
, character string"strong"
(default) for the first three elements of that vector.redact_path
a logical indicating whether options that contain "path" in the name should be redacted, default = TRUE
Details
See nflreadr::nflverse_sitrep
for details.
Examples
# \donttest{
report(recursive = FALSE)
#> ── System Info ─────────────────────────────────────────────────────────────────
#> • R version 4.4.2 (2024-10-31) • Running under: Ubuntu 22.04.5 LTS
#> ── Package Status ──────────────────────────────────────────────────────────────
#> package installed cran dev behind
#> 1 nflfastR 5.0.0.9000 5.0.0 5.0.0
#> 2 nflplotR 1.4.0.9001 1.4.0 1.4.0.9001
#> 3 nflreadr 1.4.1.06 1.4.1 1.4.1.06
#> 4 nflseedR 1.2.0 1.2.0 1.2.0.9901 dev
#> ── Package Options ─────────────────────────────────────────────────────────────
#> • No options set for above packages
#> ── Not Installed ───────────────────────────────────────────────────────────────
#> • nfl4th ()
#> • nflverse ()
#> ────────────────────────────────────────────────────────────────────────────────
nflverse_sitrep(pkg = "nflreadr", recursive = TRUE)
#> ── System Info ─────────────────────────────────────────────────────────────────
#> • R version 4.4.2 (2024-10-31) • Running under: Ubuntu 22.04.5 LTS
#> ── Package Status ──────────────────────────────────────────────────────────────
#> package installed cran dev behind
#> 1 nflreadr 1.4.1.06 1.4.1 1.4.1.06
#> ── Package Options ─────────────────────────────────────────────────────────────
#> • No options set for above packages
#> ── Package Dependencies ────────────────────────────────────────────────────────
#> • cachem (1.1.0) • glue (1.8.0) • graphics (4.4.2)
#> • cli (3.6.3) • memoise (2.0.1) • methods (4.4.2)
#> • curl (6.0.1) • rappdirs (0.3.3) • stats (4.4.2)
#> • data.table (1.16.2) • rlang (1.1.4) • tools (4.4.2)
#> • fastmap (1.2.0) • grDevices (4.4.2) • utils (4.4.2)
#> ────────────────────────────────────────────────────────────────────────────────
# }