rsyncrosim2.1.9 package

The R Interface to 'SyncroSim'

addPackage

Add SyncroSim package(s)

addRow

Add row(s) to a data.frame

backup

Backup a SsimLibrary

Chart-class

SyncroSim Chart class

chart

Create or open a chart

chartCriteria

Retrieves chart variables

chartData

Sets the Chart-class type and axes

chartDisagg

Disaggregates the Chart-class by a Y variable

chartErrorBar

Modify the error bars of a Chart-class

chartId

Retrieves chartId of SyncroSim Chart

chartInclude

Add or remove values by column in a Chart-class

chartOptionsFont

Modifies the font settings for a Chart-class

chartOptionsFormat

Modifies the font settings for a Chart-class

chartOptionsLegend

Modifies the legend settings for a Chart-class

chartOptionsXAxis

Modify the X Axis of a Chart-class

chartOptionsYAxis

Modify the Y axis of a Chart-class

command

SyncroSim console command

compact

Compacts a SsimLibrary

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 Project, Scenario, Folder, Chart or Datasheet

deleteLibrary

Delete Library

dependency

Get, set or remove Scenario dependencies

description

Description of SsimLibrary, Project or Scenario

filepath

Retrieves the path to a SyncroSim object on disk

Folder-class

SyncroSim Folder class

folder

Create or open a Folder

folderId

Retrieves folderId of SyncroSim Folder or Scenario

ignoreDependencies

Ignore dependencies for a Scenario

info

Retrieves information about a library

installConda

Installs Miniforge or Miniconda

installPackage

Adds package to SyncroSim Installation

mergeDependencies

Merge dependencies for a Scenario

name

Name of a SsimLibrary, Project, Scenario, Folder, or Chart

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

SyncroSim Project class

project

Create or open Project(s)

projectId

Retrieves projectId of SyncroSim Project, Scenario, Folder, or Chart

readOnly

Read-only status of a SsimLibrary, Project, Scenario, Folder or Chart

removePackage

Removes SyncroSim package(s)

restore

Restore Library

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

Scenario-class

SyncroSim Scenario class

scenario

Create or open Scenario(s)

scenarioId

Retrieves scenarioId of Scenario

Session-class

SyncroSim Session class

session

Create or return SyncroSim Session

signIn

Signs in to SyncroSim

signOut

Signs out of SyncroSim

silent

Silent status of SyncroSim Session

sqlStatement

Construct an SQLite query

ssimEnvironment

SyncroSim Environment

SsimLibrary-class

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

Conda configuration of a SsimLibrary

version

Retrieves SyncroSim version

viewProfile

Display SyncroSim profile

'SyncroSim' is a generalized framework for managing scenario-based datasets (<https://syncrosim.com/>). 'rsyncrosim' provides an interface to 'SyncroSim'. Simulation models can be added to 'SyncroSim' in order to transform these datasets, taking advantage of general features such as defining scenarios of model inputs, running Monte Carlo simulations, and summarizing model outputs. 'rsyncrosim' requires 'SyncroSim' 2.3.5 or higher (API documentation: <https://docs.syncrosim.com/>).

  • Maintainer: Katie Birchard
  • License: MIT + file LICENSE
  • Last published: 2025-10-14