R: The R Interface to 'SyncroSim'

# The R Interface to 'SyncroSim'

## Documentation for package ‘rsyncrosim’ version 2.1.13

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

A B C D F I M N O P R S T U V

## -- A --

addPackage | Add SyncroSim package(s)
addPackage-method | Add SyncroSim package(s)
addRow | Add row(s) to a data.frame
addRow-method | Add row(s) to a data.frame

## -- B --

backup | Backup a SsimLibrary
backup-method | Backup a SsimLibrary

## -- C --

chart | Create or open a chart
Chart-class | SyncroSim Chart class
chart-method | Create or open a chart
chartCriteria | Retrieves chart variables
chartCriteria-method | Retrieves chart variables
chartData | Sets the 'Chart' type and axes
chartData-method | Sets the 'Chart' type and axes
chartDisagg | Disaggregates the 'Chart' by a Y variable
chartDisagg-method | Disaggregates the 'Chart' by a Y variable
chartErrorBar | Modify the error bars of a 'Chart'
chartErrorBar-method | Modify the error bars of a 'Chart'
chartId | Retrieves chartId of SyncroSim Chart
chartId-method | Retrieves chartId of SyncroSim Chart
chartInclude | Add or remove values by column in a 'Chart'
chartInclude-method | Add or remove values by column in a 'Chart'
chartOptionsFont | Modifies the font settings for a 'Chart'
chartOptionsFont-method | Modifies the font settings for a 'Chart'
chartOptionsFormat | Modifies the font settings for a 'Chart'
chartOptionsFormat-method | Modifies the font settings for a 'Chart'
chartOptionsLegend | Modifies the legend settings for a 'Chart'
chartOptionsLegend-method | Modifies the legend settings for a 'Chart'
chartOptionsXAxis | Modify the X Axis of a 'Chart'
chartOptionsXAxis-method | Modify the X Axis of a 'Chart'
chartOptionsYAxis | Modify the Y axis of a 'Chart'
chartOptionsYAxis-method | Modify the Y axis of a 'Chart'
command | SyncroSim console command
compact | Compacts a SsimLibrary
compact-method | Compacts a SsimLibrary
condaFilepath | Path to Conda installation folder
condaFilepath-method | Path to Conda installation folder
condaFilepath<- | Path to Conda installation folder
condaFilepath<--method | Path to Conda installation folder
createCondaEnv | Create SyncroSim package conda environments
createCondaEnv-method | Create SyncroSim package conda environments

## -- D --

datasheet | Retrieve a SyncroSim Datasheet
datasheet-method | Retrieve a SyncroSim Datasheet
datasheetSpatRaster | Retrieve spatial data from a SyncroSim Datasheet
datasheetSpatRaster-method | Retrieve spatial data from a SyncroSim Datasheet
dateModified | Last date a SsimLibrary, Project, Scenario, or Folder was modified
dateModified-method | Last date a SsimLibrary, Project, Scenario, or Folder was modified
delete | Delete Project, Scenario, Folder, Chart or Datasheet
delete-method | Delete Project, Scenario, Folder, Chart or Datasheet
deleteLibrary | Delete Library
deleteLibrary-method | Delete Library
dependency | Get, set or remove Scenario dependencies
dependency-method | Get, set or remove Scenario dependencies
dependency<- | Get, set or remove Scenario dependencies
dependency<--method | Get, set or remove Scenario dependencies
description | Description of SsimLibrary, Project or Scenario
description-method | Description of SsimLibrary, Project or Scenario
description<- | Description of SsimLibrary, Project or Scenario
description<--method | Description of SsimLibrary, Project or Scenario

## -- F --

filepath | Retrieves the path to a SyncroSim object on disk
filepath-method | Retrieves the path to a SyncroSim object on disk
folder | Create or open a Folder
Folder-class | SyncroSim Folder class
folderId | Retrieves folderId of SyncroSim Folder or Scenario
folderId-method | Retrieves folderId of SyncroSim Folder or Scenario
folderId<- | Retrieves folderId of SyncroSim Folder or Scenario
folderId<--method | Retrieves folderId of SyncroSim Folder or Scenario

## -- I --

ignoreDependencies | Ignore dependencies for a Scenario
ignoreDependencies-method | Ignore dependencies for a Scenario
ignoreDependencies<- | Ignore dependencies for a Scenario
ignoreDependencies<--method | Ignore dependencies for a Scenario
info | Retrieves information about a library
info-method | Retrieves information about a library
installConda | Installs Miniforge or Miniconda
installConda-method | Installs Miniforge or Miniconda
installPackage | Adds package to SyncroSim Installation
installPackage-method | Adds package to SyncroSim Installation

## -- M --

mergeDependencies | Merge dependencies for a Scenario
mergeDependencies-method | Merge dependencies for a Scenario
mergeDependencies<- | Merge dependencies for a Scenario
mergeDependencies<--method | Merge dependencies for a Scenario

## -- N --

name | Name of a SsimLibrary, Project, Scenario, Folder, or Chart
name-method | Name of a SsimLibrary, Project, Scenario, Folder, or Chart
name<- | Name of a SsimLibrary, Project, Scenario, Folder, or Chart
name<--method | Name of a SsimLibrary, Project, Scenario, Folder, or Chart

## -- O --

owner | Owner of a SsimLibrary, Project, or Scenario
owner-method | Owner of a SsimLibrary, Project, or Scenario
owner<- | Owner of a SsimLibrary, Project, or Scenario
owner<--method | Owner of a SsimLibrary, Project, or Scenario

## -- P --

packages | Installed or available packages
packages-method | Installed or available packages
parentId | Retrieves the parent Scenario id or parent Folder id
parentId-method | Retrieves the parent Scenario id or parent Folder id
printCmd | Retrieves printCmd setting of a Session
printCmd-method | Retrieves printCmd setting of a Session
progressBar | Sets the progress bar in the SyncroSim User Interface
project | Create or open Project(s)
Project-class | SyncroSim Project class
projectId | Retrieves projectId of SyncroSim Project, Scenario, Folder, or Chart
projectId-method | Retrieves projectId of SyncroSim Project, Scenario, Folder, or Chart

## -- R --

readOnly | Read-only status of a SsimLibrary, Project, Scenario, Folder or Chart
readOnly-method | Read-only status of a SsimLibrary, Project, Scenario, Folder or Chart
readOnly<- | Read-only status of a SsimLibrary, Project, Scenario, Folder or Chart
readOnly<--method | Read-only status of a SsimLibrary, Project, Scenario, Folder or Chart
removePackage | Removes SyncroSim package(s)
removePackage-method | Removes SyncroSim package(s)
restore | Restore Library
restore-method | Restore Library
rsyncrosim | rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/
run | Run scenarios
run-method | Run scenarios
runLog | Retrieves run log of result Scenario
runLog-method | Retrieves run log of result Scenario
runtimeDataFolder | SyncroSim Data Folder
runtimeTempFolder | SyncroSim Temporary Folder

## -- S --

saveDatasheet | Save datasheet
saveDatasheet-method | Save datasheet
scenario | Create or open Scenario(s)
Scenario-class | SyncroSim Scenario class
scenarioId | Retrieves scenarioId of Scenario
scenarioId-method | Retrieves scenarioId of Scenario
session | Create or return SyncroSim Session
Session-class | SyncroSim Session class
session-method | Create or return SyncroSim Session
session<- | Create or return SyncroSim Session
session<--method | Create or return SyncroSim Session
signIn | Signs in to SyncroSim
signOut | Signs out of SyncroSim
silent | Silent status of SyncroSim Session
silent-method | Silent status of SyncroSim Session
silent<- | Silent status of SyncroSim Session
silent<--method | Silent status of SyncroSim Session
sqlStatement | Construct an SQLite query
ssimEnvironment | SyncroSim Environment
ssimLibrary | Create or open a SsimLibrary
SsimLibrary-class | SyncroSim Library class
ssimLibrary-method | Create or open a SsimLibrary

## -- T --

tempfilepath | Retrieves the temporary file path to a SyncroSim object on disk
tempfilepath-method | Retrieves the temporary file path to a SyncroSim object on disk

## -- U --

uninstallPackage | Removes a package from SyncroSim installation
uninstallPackage-method | Removes a package from SyncroSim installation
updateRunLog | Function to write to the SyncroSim run log
useConda | Conda configuration of a SsimLibrary
useConda-method | Conda configuration of a SsimLibrary
useConda<- | Conda configuration of a SsimLibrary
useConda<--method | Conda configuration of a SsimLibrary

## -- V --

version | Retrieves SyncroSim version
version-method | Retrieves SyncroSim version
viewProfile | Display SyncroSim profile