addon: Addon(s) installed in SsimLibrary or Session

Description Usage Arguments Value Examples

Description

Lists the addon SyncroSim package(s) associated with a SsimLibrary or Session. These packages can only be used to extend existing SyncroSim base packages; as a result they cannot be used to create new SsimLibraries. For example, stsimsf is an addon for stsim which provides optional additional functionality for the base ST-Sim model. More information on addons can be found in the syncrosim documentation.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
addon(ssimObject)

## S4 method for signature 'character'
addon(ssimObject)

## S4 method for signature 'missingOrNULL'
addon(ssimObject)

## S4 method for signature 'Session'
addon(ssimObject)

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

Arguments

ssimObject

SsimLibrary or Session object. If NULL (default), session() will be used

Value

A data.frame listing the addon(s) in use by the SsimLibrary or Session to which the object belongs.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Install the base package "stsim"
addPackage("stsim")

# Set the file path and name of the new SsimLibrary
myLibraryName <- file.path(tempdir(),"testlib")

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

# Retrieve a data.frame of available add-on(s) for the SsimLibrary
addon(myLibrary)

rsyncrosim documentation built on Oct. 28, 2021, 1:07 a.m.