Function reference • rsyncrosim

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<-`()	Auto Generation Tags for a Scenario
`backup()`	Backup a SsimLibrary
`breakpoint()`	Breakpoints for a Scenario
`command()`	SyncroSim console command
`condaFilepath()` `condaFilepath<-`()	Path to Conda installation folder
`datasheet()`	Retrieve a SyncroSim Datasheet
`datasheetRaster()`	Retrieve spatial data from a SyncroSim Datasheet
`datasheetSpatRaster()`	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<-`()	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
`Folder-class` `Folder`	SyncroSim Folder class
`folder()`	Create or open a Folder
`folderId()` `folderId<-`()	Retrieves folderId of SyncroSim Folder or Scenario
`ignoreDependencies()` `ignoreDependencies<-`()	Ignore dependencies for a Scenario
`info()`	Retrieves information about a library
`installConda()`	Installs Miniconda
`mergeDependencies()` `mergeDependencies<-`()	Merge dependencies for a Scenario
`name()` `name<-`()	Name of a SsimLibrary, Project, Scenario, or Folder
`owner()` `owner<-`()	Owner of a SsimLibrary, Project, Scenario, or Folder
`package()`	Installed or available packages
`parentId()`	Retrieves the parent Scenario id or parent Folder id
`printCmd()`	Retrieves printCmd setting of a Session
`progressBar()`	Sets the progress bar in the SyncroSim User Interface
`Project-class` `Project`	SyncroSim Project class
`project()`	Create or open Project(s)
`projectId()`	Retrieves projectId of SyncroSim Project, Scenario, or Folder
`readOnly()` `readOnly<-`()	Read-only status of a SsimLibrary, Project, Scenario or Folder
`removePackage()`	Removes package from SyncroSim installation
`rsyncrosim` `rsyncrosim-package`	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` `Scenario`	SyncroSim Scenario class
`scenario()`	Create or open Scenario(s)
`scenarioId()`	Retrieves scenarioId of Scenario
`Session-class` `Session`	SyncroSim Session class
`session()` `session<-`()	Create or return SyncroSim Session
`silent()` `silent<-`()	Silent status of SyncroSim Session
`sqlStatement()`	Construct an SQLite query
`ssimEnvironment()`	SyncroSim Environment
`SsimLibrary-class` `SsimLibrary`	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
`updateRunLog()`	Function to write to the SyncroSim run log
`useConda()` `useConda<-`()	Conda configuration of a SsimLibrary
`version()`	Retrieves SyncroSim version

Reference

All functions