Restore Library

Restores a SyncroSim library from a backup file.

Usage

restore(ssimLibraryBackup, folder = NULL, session = NULL)

# S4 method for class 'character'
restore(ssimLibraryBackup, folder = NULL, session = NULL)

Arguments

ssimLibraryBackup

SsimLibrary backup file or path to a library backup file

folder

Optional folder to restore the library into. If NULL, restores to default location.

session

SyncroSim session

Value

"Library restored" or "Library restoration failed".

Examples

if (FALSE) { # \dontrun{
# Specify file path and name of SsimLibrary backup file
myLibraryBackupName <- file.path(tempdir(), "testlib.ssimbak")

# Set up a SyncroSim Session and create SsimLibrary from backup file
mySession <- session()
myLibrary <- restore(ssimLibraryBackup = myLibraryBackupName, session = mySession)

} # }