restoreSession: Restore an R Session

In Sage-Bionetworks/sessionTools: Tools for saving, restoring and teleporting R sessions.

Description

A wrapper function for restoring a session from a binary file.

Usage

restoreSession(file = "session.RData", envir = .GlobalEnv, clean = TRUE)

Arguments

file	path to an R binary file
envir	the environment into which the objects should be restored.
clean	boolean indicating whether the environment should be purged prior to restoring objects

Details

This function restores an entire workspace by calling restoreObjects, followed by calls to restorePackages, restoreSearchPath and restoreOptions if the file contains an object named .sessionInfo, that must be generated by a call to sessionSummary

Value

This function is called for it's side-effects

Author(s)

Matthew D. Furia [e-mail]

https://github.com/MattNapsAlot

See Also

restoreObjects, restoreSearchPath, restorePackages, restoreOptions, sessionSummary, saveSession

Examples

## Not run: 
## save the session
saveSession(file="sessionInfo.rbin")

## restore a saved session
restoreSession(file="sessionInfo.rbin")

## End(Not run)

Sage-Bionetworks/sessionTools documentation built on May 9, 2019, 12:13 p.m.