Skip to contents

Get a Situation Report on System, nflverse/ffverse Package Versions and Dependencies

Source: R/utils_sitrep.R
sitrep.Rd

This function gives a quick overview of the versions of R and the operating system as well as the versions of nflverse/ffverse 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.

Usage

nflverse_sitrep(
  pkg = c("nflreadr", "nflfastR", "nflseedR", "nfl4th", "nflplotR", "nflverse"),
  recursive = TRUE,
  redact_path = TRUE
)

ffverse_sitrep(
  pkg = c("ffscrapr", "ffsimulator", "ffpros", "ffopportunity"),
  recursive = TRUE,
  redact_path = TRUE
)

.sitrep(pkg, recursive = TRUE, header = "", redact_path = TRUE)

Arguments

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 of c("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

header

a string that is printed in the horizontal separation lines and used to differentiate between nflverse and ffverse output.

Examples

# \donttest{
try({
nflverse_sitrep()
ffverse_sitrep()
.sitrep("cachem")
})
#> ℹ You've asked for the packages nflfastR, nflseedR, nfl4th, nflplotR, and nflverse which are not installed. 
#> They are skipped.
#> ── System Info ─────────────────────────────────────────────────────────────────
#> • R version 4.3.0 (2023-04-21)   • Running under: Ubuntu 22.04.2 LTS
#> ── nflverse Packages ───────────────────────────────────────────────────────────
#> • nflreadr (1.3.2.03)
#> ── nflverse Options ────────────────────────────────────────────────────────────
#> No options set for nflreadr
#> ── nflverse Dependencies ───────────────────────────────────────────────────────
#> • cachem (1.0.8)  • data.table (1.14.8)  • memoise  (2.0.1)  
#> • cli    (3.6.1)  • fastmap    (1.1.1)   • rappdirs (0.3.3)  
#> • curl   (5.0.0)  • glue       (1.6.2)   • rlang    (1.1.1)  
#> ────────────────────────────────────────────────────────────────────────────────
#> ℹ You've asked for the packages ffscrapr, ffsimulator, ffpros, and ffopportunity which are not installed. 
#> They are skipped.
#> ── System Info ─────────────────────────────────────────────────────────────────
#> • R version 4.3.0 (2023-04-21)   • Running under: Ubuntu 22.04.2 LTS
#> ── Packages ────────────────────────────────────────────────────────────────────
#> • cachem (1.0.8)
#> ── Options ─────────────────────────────────────────────────────────────────────
#> No options set for cachem
#> ── Dependencies ────────────────────────────────────────────────────────────────
#> • fastmap (1.1.1)
#> • rlang   (1.1.1)
#> ────────────────────────────────────────────────────────────────────────────────
# }