Learn R Programming

⚠️There's a newer version (2.0.1) of this package.Take me there.

rsyncrosim

The R interface to SyncroSim

About SyncroSim

SyncroSim is a software platform that helps you turn your data into forecasts. At the core of SyncroSim is an engine that automatically structures your existing data, regardless of its original format. SyncroSim transforms this structured data into forecasts by running it through a Pipeline of calculations (i.e. a suite of models). Finally, SyncroSim provides a rich interface to interact with your data and models, allowing you to explore and track the consequences of alternative “what-if” forecasting Scenarios. Within this software framework is the ability to use and create SyncroSim packages.

For more details consult the SyncroSim online documentation.

About rsyncrosim

The simplest way to run SyncroSim from the command-line is to use the R programming language, in conjunction with the open-source rsyncrosim R package. This R package is designed to make it simple to script modeling workflows for SyncroSim in R, by providing functions that allow users to create models from scratch, populate those models with inputs, run the models for multiple scenarios, and access both spatial and tabular model output. The package is designed to work with any SyncroSim Package.

A key feature of the rsyncrosim package is its ability to work seamlessly with the SyncroSim user interface. By integrating model scripting and visualization, users can interactively explore and validate their models in the user interface as they step through their R code, and at the same time generate a permanent, repeatable record of their entire modeling workflow – including both pre- and post-processing of model inputs and outputs – in an R script.

Installation

Getting Started

Copy Link

Version

Install

install.packages('rsyncrosim')

Monthly Downloads

309

Version

1.5.0

License

MIT + file LICENSE

Maintainer

Katie Birchard

Last Published

February 1st, 2024

Functions in rsyncrosim (1.5.0)

datasheetRaster

Retrieve spatial data from a SyncroSim Datasheet
condaFilepath

Path to Conda installation folder
backup

Backup a SsimLibrary
command

SyncroSim console command
basePackage

Installed base packages
enableAddon

Enable addon package(s)
delete

Delete SsimLibrary, Project, Scenario, Datasheet
description

Description of SsimLibrary, Project or Scenario
dateModified

Last date a SsimLibrary, Project or Scenario was modified
envInputFolder

SyncroSim DataSheet Input Folder
disableAddon

Disable addon package(s)
folderId

Retrieves folderId of SyncroSim Folder or Scenario
ignoreDependencies

Ignore dependencies for a Scenario
envBeginSimulation

Begins a SyncroSim simulation
envEndSimulation

Ends a SyncroSim simulation
name

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

Auto Generation Tags for a Scenario
module

Installed modules
dependency

Get, set or remove Scenario dependency(s)
envOutputFolder

SyncroSim DataSheet Output Folder
folder

Create or open a Folder
deletePackage

Deletes a package from your SyncroSim installation
filepath

Retrieves the path to a SyncroSim object on disk
envReportProgress

Reports SyncroSim simulation progress
info

Retrieves information about a library
deleteBreakpoint

Delete a Scenario breakpoint
deleteModule

Delete module or modules
envTempFolder

SyncroSim Temporary Folder
envStepSimulation

Steps a SyncroSim simulation
owner

Owner of a SsimLibrary, Project, Scenario, or Folder
package

Installed or available packages
mergeDependencies

Merge dependencies for a Scenario
projectId

Retrieves projectId of SyncroSim Project, Scenario, or Folder
model

Installed models
run

Run scenarios
installConda

Installs Miniconda
ssimEnvironment

SyncroSim Environment
sqlStatement

Construct an SQLite query
version

Retrieves SyncroSim version
parentId

Retrieves the parent Scenario id or parent Folder id
ssimLibrary

Create or open a SsimLibrary
runLog

Retrieves run log of result Scenario
ssimUpdate

Apply updates
project

Create or open Project(s)
progressBar

Sets the progress bar in the SyncroSim User Interface
removePackage

Removes package from SyncroSim installation
printCmd

Retrieves printCmd setting of a Session
silent

Silent status of SyncroSim Session
updateRunLog

Function to write to the SyncroSim run log
rsyncrosim

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

Create or return SyncroSim Session
tempfilepath

Retrieves the temporary file path to a SyncroSim object on disk
readOnly

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

Update Package
scenarioId

Retrieves scenarioId of Scenario
runtimeOutputFolder

SyncroSim DataSheet Output Folder
scenario

Create or open Scenario(s)
runtimeInputFolder

SyncroSim DataSheet Input Folder
useConda

Conda configuration of a SsimLibrary
runtimeTempFolder

SyncroSim Temporary Folder
saveDatasheet

Save Datasheet(s)
Folder-class

SyncroSim Folder class
addModule

Add module
Scenario-class

SyncroSim Scenario class
addPackage

Adds package to SyncroSim Installation
Project-class

SyncroSim Project class
Session-class

SyncroSim Session class
SsimLibrary-class

SyncroSim Library class
addPackageFile

Adds a package to SyncroSim
addBreakpoint

Add a Scenario breakpoint
addRow

Add row(s) to a data.frame
datasheet

Retrieve a SyncroSim Datasheet
breakpoint

Breakpoints for a Scenario
datasheetSpatRaster

Retrieve spatial data from a SyncroSim Datasheet
addon

Addon(s) installed in SsimLibrary or Session