All functions

addBreakpoint()

Add a Scenario breakpoint

addon()

Addon(s) installed in SsimLibrary or Session

addPackage()

Adds package to SyncroSim Installation

addRow()

Add row(s) to a data.frame

autogentags() `autogentags<-`(<character>) `autogentags<-`(<Scenario>)

Auto Generation Tags for a Scenario

backup()

Backup a SsimLibrary

breakpoint()

Breakpoints for a Scenario

command()

SyncroSim console command

datasheet()

Retrieve a SyncroSim Datasheet

datasheetRaster()

Retrieve spatial data from a SyncroSim Datasheet

dateModified()

Last date a SsimLibrary, Project or Scenario was modified

delete()

Delete SsimLibrary, Project, Scenario, Datasheet

deleteBreakpoint()

Delete a Scenario breakpoint

dependency()

Get, set or remove Scenario dependency(s)

description() `description<-`(<character>) `description<-`(<SsimObject>)

Description of SsimLibrary, Project or Scenario

disableAddon()

Disable addon package(s)

enableAddon()

Enable addon package(s)

filepath()

Retrieves the path to a SyncroSim object on disk

ignoreDependencies() `ignoreDependencies<-`(<character>) `ignoreDependencies<-`(<Scenario>)

Ignore dependencies for a Scenario

info()

Retrieves information about a library

mergeDependencies() `mergeDependencies<-`(<character>) `mergeDependencies<-`(<Scenario>)

Merge dependencies for a Scenario

name() `name<-`(<character>) `name<-`(<SsimLibrary>) `name<-`(<Project>) `name<-`(<Scenario>)

Name of a SsimLibrary, Project or Scenario

owner() `owner<-`(<character>) `owner<-`(<SsimObject>)

Owner of a SsimLibrary, Project or Scenario

package()

Installed or available packages

parentId()

Retrieves the parent Scenario id

printCmd()

Retrieves printCmd setting of a Session

progressBar()

Sets the progress bar in the SyncroSim User Interface

Project-class

SyncroSim Project class

project()

Create or open Project(s)

projectId()

Retrieves projectId of SyncroSim Project or Scenario

readOnly() `readOnly<-`(<character>) `readOnly<-`(<SsimObject>)

Read-only status of a SsimLibrary, Project or Scenario

removePackage()

Removes package from SyncroSim installation

rsyncrosim

rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/

run()

Run scenarios

runLog()

Retrieves run log of result Scenario

runtimeInputFolder()

SyncroSim DataSheet Input Folder

runtimeOutputFolder()

SyncroSim DataSheet Output Folder

runtimeTempFolder()

SyncroSim Temporary Folder

saveDatasheet()

Save Datasheet(s)

Scenario-class

SyncroSim Scenario class

scenario()

Create or open Scenario(s)

scenarioId()

Retrieves scenarioId of Scenario

Session-class

SyncroSim Session class

session() `session<-`(<character>) `session<-`(<SsimObject>)

Create or return SyncroSim Session

silent() `silent<-`(<character>) `silent<-`(<Session>)

Silent status of SyncroSim Session

sqlStatement()

Construct an SQLite query

ssimEnvironment()

SyncroSim Environment

SsimLibrary-class

SyncroSim Library class

ssimLibrary()

Create or open a SsimLibrary

ssimUpdate()

Apply updates

tempfilepath()

Retrieves the temporary file path to a SyncroSim object on disk

updatePackage()

Update Package

version()

Retrieves SyncroSim version