startup_session_options: Record R session information as options

View source: R/startup_session_options.R

startup_session_optionsR Documentation

Record R session information as options

Description

Record R session information as options

Usage

startup_session_options(action = c("update", "overwrite", "erase"))

Arguments

action

If "update" or "overwrite", R options "startup.session.*" are set. If "update", then such options that are not already set are updated. If "erase", any existing "startup.session.*" options are removed.

Value

Returns invisibly a named list of the options prefixed "startup.session.":

startup.session.startdir

(character) the working directory when the startup was first loaded. If startup::startup() is called at the very beginning of the ‘.Rprofile’ file, this is also the directory that the current R session was launched from.

startup.session.starttime

(POSIXct) the time when the startup was first loaded.

startup.session.id

(character) a unique ID for the current R session.

startup.session.dumpto

(character) a session-specific name that can be used for argument dumpto of dump.frames() (also for dumping to file).

Examples

opts <- startup::startup_session_options()
opts


startup documentation built on April 3, 2023, 5:48 p.m.