rsyncrosim (version 2.0.1)

backup: Backup a SsimLibrary

Description

Backup a SsimLibrary. The backup folder can be defined in the SyncroSim User Interface, but is by default at the same level as the SsimLibrary file, and is called libraryName.backup.

Usage

backup(ssimObject)
# S4 method for character
backup(ssimObject)
# S4 method for SsimObject
backup(ssimObject)

Value

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

Arguments

ssimObject

SsimLibrary, Project or Scenario object

Examples

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

# Set up a SyncroSim Session, SsimLibrary, and Project
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)

# Back up data from the SsimLibrary
backup(myLibrary)
}