env_doc: Report the working environment in which an analysis was...

In envDocument: Document the R Working Environment

Report the working environment in which an analysis was performed.

Description

env_doc prints or returns a data frame with the following information: - System version (OS, version, user, working directory)

Usage

env_doc(
  output = c("return", "print", "table"),
  system = TRUE,
  version = TRUE,
  packages = TRUE,
  script = TRUE,
  git = TRUE,
  renv = TRUE,
  domino = c("auto", "on", "off")
)

Arguments

output	How should output be handled? Character, values: return - return as a data frame (default); print - print to stdout; table - pretty-print using knitr::kable (requires package knitr)
system	Include OS info from getSysInfo? Boolean, default TRUE
version	Include R version from getRversion? Boolean, default TRUE
packages	Include attached packages with repository and version from getPackageInfo? Boolean, default TRUE
script	Include script path and modification time from getScriptInfo? Boolean, default TRUE
git	Include git repository information from getGitInfo (note: requires git2r)? Boolean, default TRUE
renv	Include renv status information from getRenvStatus? Boolean, default TRUE
domino	Include Domino Datalab run information from getDominoInfo? Character, values: auto - include if available; on - include with warning if not available; off - do not include evn if available

Details

- R version

- Package names and versions

- Top-level script name and modification time

- Git hash, status and tag (if any; requires package git2r)

Value

If output = return (default): A data frame with columns for information type, variable name and value. NULL for output = print or output = table

Examples

## Not run:  
 # Note that these only work when called in a script or markdown document
 env_doc("print") # print information to stdout
 info <- env_doc() # return information as a consolidated data frame
 
## End(Not run)

envDocument documentation built on Sept. 11, 2025, 9:08 a.m.