compact: Compacts a SsimLibrary
In rsyncrosim: The R Interface to 'SyncroSim'

compact

R Documentation

Compacts a SsimLibrary

Description

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

Usage

compact(ssimLibrary)

## S4 method for signature 'character'
compact(ssimLibrary)

## S4 method for signature 'SsimLibrary'
compact(ssimLibrary)

Arguments

ssimLibrary

SsimLibrary-class object

Value

Invisibly returns TRUE upon success (i.e.successful compacting) 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)

# Compact data from the SsimLibrary
compact(myLibrary)

## End(Not run)

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