backup: Backup a SsimLibrary

In rsyncrosim: The R Interface to 'SyncroSim'

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 signature 'character'
backup(ssimObject)

## S4 method for signature 'SsimObject'
backup(ssimObject)

Arguments

ssimObject

SsimLibrary, Project or Scenario object

Value

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

Examples

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

## End(Not run)

rsyncrosim documentation built on Oct. 15, 2024, 1:06 a.m.