info: Retrieves information about a library

In rsyncrosim: The R Interface to 'SyncroSim'

Retrieves information about a library

Description

Retrieves some basic metadata about a SsimLibrary: Name, Owner, Last Modified, Size, Read Only, Package Name, Package Description, Current Package Version, Minimum Package Version, External input files, External output files, Temporary files, Backup files.

Usage

info(ssimLibrary)

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

Arguments

ssimLibrary

SsimLibrary object

Value

Returns a data.frame with information on the properties of the SsimLibrary object.

Examples

## Not run: 
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

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

# Get information about SsimLibrary  
info(myLibrary)

## End(Not run)

rsyncrosim documentation built on Oct. 7, 2023, 9:08 a.m.