Package index • rsyncrosim

All functions

addPackage(): Add SyncroSim package(s)

addRow(): Add row(s) to a data.frame

backup(): Backup a SsimLibrary

Chart-class Chart: SyncroSim Chart class

chart(): Create or open a chart

chartCriteria(): Retrieves chart variables

chartData(): Sets the Chart type and axes

chartDisagg(): Disaggregates the Chart by a Y variable

chartErrorBar(): Modify the error bars of a Chart

chartId(): Retrieves chartId of SyncroSim Chart

chartInclude(): Add or remove values by column in a Chart

chartOptionsFont(): Modifies the font settings for a Chart

chartOptionsFormat(): Modifies the font settings for a Chart

chartOptionsLegend(): Modifies the legend settings for a Chart

chartOptionsXAxis(): Modify the X Axis of a Chart

chartOptionsYAxis(): Modify the Y axis of a Chart

command(): SyncroSim console command

condaFilepath() `condaFilepath<-`(): Path to Conda installation folder

createCondaEnv(): Create SyncroSim package conda environments

datasheet(): Retrieve a SyncroSim Datasheet

datasheetSpatRaster(): Retrieve spatial data from a SyncroSim Datasheet

dateModified(): Last date a SsimLibrary, Project, Scenario, or Folder was modified

delete(): Delete SsimLibrary, Project, Scenario, Folder, Chart or Datasheet

deleteLibrary(): Delete Library

dependency() `dependency<-`(): Get, set or remove Scenario dependency(s)

description() `description<-`(): Description of SsimLibrary, Project or Scenario

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

installPackage(): Adds package to SyncroSim Installation

mergeDependencies() `mergeDependencies<-`(): Merge dependencies for a Scenario

name() `name<-`(): Name of a SsimLibrary, Project, Scenario, Folder, or Chart

owner() `owner<-`(): Owner of a SsimLibrary, Project, or Scenario

packages(): 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, Folder, or Chart

readOnly() `readOnly<-`(): Read-only status of a SsimLibrary, Project, Scenario or Folder

removePackage(): Removes SyncroSim package(s)

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

run(): Run scenarios

runLog(): Retrieves run log of result Scenario

runtimeDataFolder(): SyncroSim Data 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

tempfilepath(): Retrieves the temporary file path to a SyncroSim object on disk

uninstallPackage(): Removes a package from SyncroSim installation

updateRunLog(): Function to write to the SyncroSim run log

useConda() `useConda<-`(): Conda configuration of a SsimLibrary

version(): Retrieves SyncroSim version