Learn R Programming

envDocument

A R package to report various aspects of the environment in which an analysis was run. This includes system information, packages used, working directory, script path and git repository (if any; uses git2r).

Output can be returned as a data table, printed, or formatted using knitr::kable.

Usage


# get environment information as a data frame
info <- env_doc()

# format environment information as a table
env_doc("table")

# print environment information
env_doc("print")

Copy Link

Version

Install

install.packages('envDocument')

Monthly Downloads

525

Version

2.4.1

License

GPL (>= 3.0)

Issues

Pull Requests

Stars

Forks

Maintainer

Donald Jackson

Last Published

August 19th, 2019

Functions in envDocument (2.4.1)

remoteInfo

Look up remotes for repository
getDominoInfo

Get information about a Domino Datalab run from environment variables in the run environment
env_doc

Report the working environment in which an analysis was performed.
get_Rversion

Get information on R version
infoNotFound

Return a consistent failure result when something is not available
getScriptInfo

Get information about the calling script
envDocument-package

Document the environment under which an analysis was performed
getPackageInfo

Get information on attached packages
getGitInfo

Get git repository information for a script
getRepo

Locate the git repository where a file is tracked
getScriptPath

Get the path of the calling script
collapseInfo

Collapse list of enviornment information into a single data frme
prettyPrintInfo

Output environment information as individual tables per section
getSysInfo

Get system information.