rsyncrosim (version 2.1.9)

compact: Compacts a SsimLibrary

Description

Compact a SsimLibrary-class. Removes extraneous data from the SyncroSim library.

Usage

compact(ssimLibrary)
# S4 method for character
compact(ssimLibrary)
# S4 method for SsimLibrary
compact(ssimLibrary)

Value

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

Arguments

ssimLibrary

SsimLibrary-class 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)

# Compact data from the SsimLibrary
compact(myLibrary)
}