sessionInfoX: Extended Information About the Current R Session

View source: R/sessionInfo-ext.R

sessionInfoXR Documentation

Extended Information About the Current R Session

Description

Collect (and print) information about the current R session and environment, using sessionInfo() and more mostly low-level and platform dependent information.

isRshared() is a utility called from sessionInfoX().

Usage

sessionInfoX(pkgs = NULL, list.libP = FALSE, extraR.env = TRUE)

## S3 method for class 'sessionInfoX'
print(x, locale = TRUE, RLIBS = TRUE, Renv = TRUE, ...)

isRshared(platform = .Platform)

Arguments

pkgs

NULL (default), TRUE or a character vector of R package names, whose packageDescription()s are wanted. No packages by default, TRUE takes all currently loaded pkgs.

list.libP

a logical indicating if for all .libPaths entries, the files should be listed via list.files.

extraR.env

logical indicating if all environment variables should be recorded which start with "R_" or "_R_".

x

typically the result of sessionInfoX().

locale

logical, passed to print.sessionInfo() indicating if the locale information should be printed.

RLIBS

logical indicating if the information about R_LIBS should be printed.

Renv

logical indicating if the information about R environment variables should be printed.

...

passed to print methods.

platform

a list “like” .Platform.

Value

For isRshared(), a logical indicating if R has been installed as “shared”, i.e., linked to ‘libR*’ shared library.

For sessionInfoX(), an object of S3 class "sessionInfoX", a list with components (there may be more, experimental and not yet listed here):

sInfo

simply the value of sessionInfo().

sysInf

the value of Sys.info().

capabilities

the value of capabilities().

extSoft

for R 3.2.0 and newer, the value of extSoftVersion().

grSoft

for R 3.2.0 and newer, the value of grSoftVersion().

tclVersion

for R 3.2.0 and newer and when tcltk is loaded, the Tcl version (tclVersion()).

LAPACK

for R 3.0.3 and newer, the value of La_version().

pcre

for R 3.1.3 and newer, the value of pcre_config().

pkgDescr

If pkgs was non-empty, a named list of packageDescription()s for each entry in pkgs.

libPath

the value of .libPaths().

RLIBS

a character vector of entries from Sys.getenv("R_LIBS"), typically very similar to the libPaths component.

n.RLIBS

simply a normalizePath()ed version of RLIBS.

R.env

a named character vector with the “important” R environment variables R_ENVIRON, R_PROFILE, R_CHECK_ENVIRON.

xR.env

if extraR.env was true, a named character vector of “all R related” environment variables, as specified in extraR.env's description above.

shared

(not available on Windows, where it is conceptually always true:) logical indicating if the version of R is “shared”.

Author(s)

Martin Maechler, December 2015 ff.

See Also

sessionInfo, .libPaths, R.version, Sys.getenv.

Examples

six0 <- sessionInfoX()
six0$shared # useful (for some, e.g., MM) on Unix alikes

sixN <- sessionInfoX("nlme", list.libP = TRUE)
sixN # -> print() method for "sessionInfoX"
names(sixN)
str(sixN, max = 1)# outline of lower-level structure
str(sixN$pkgDescr) # list with one component "nlme"

sfsmisc documentation built on Aug. 10, 2023, 5:06 p.m.