rsyncrosim (version 2.1.9)

restore: Restore Library

Description

Restores a SyncroSim library from a backup file.

Usage

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

Value

Invisibly returns TRUE upon success (i.e. successful restore) and FALSE upon failure.

Arguments

ssimLibraryBackup

character string. Path to a library backup file

folder

character string. Optional path to a folder to restore the library into. If NULL, restores to default location. If the folder specified does not exist, it will be created.

session

SyncroSim session.

Examples

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

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

}