report (version 0.4.0)

report.sessionInfo: Report R environment (packages, system, etc.)

Description

Report R environment (packages, system, etc.)

Usage

# S3 method for sessionInfo
report(x, ...)
report_packages(session = NULL, include_R = TRUE, ...)
cite_packages(session = NULL, include_R = TRUE, ...)
report_system(session = NULL)

Arguments

x

The R object that you want to report (see list of of supported objects above).

...

Arguments passed to or from other methods.

session

A sessionInfo object.

include_R

Include R in the citations.

Value

• For report_packages, a data frame of class with information on package name, version and citation.

An object of class report().

Examples

# NOT RUN {
library(report)

session <- sessionInfo()

r <- report(session)
r
summary(r)
as.data.frame(r)
summary(as.data.frame(r))

# Convenience functions
report_packages(include_R = FALSE)
cite_packages(prefix = "> ")
report_system()
# }