restore: Restore Library

In rsyncrosim: The R Interface to 'SyncroSim'

Restore Library

Description

Restores a SyncroSim library from a backup file.

Usage

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

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

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.

Value

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

Examples

## Not run: 
# 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)


## End(Not run)

rsyncrosim documentation built on Nov. 7, 2025, 5:14 p.m.