Learn R Programming

rsyncrosim

The R interface to SyncroSim

Click here to view the rsyncrosim version 1 documentation.

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

244

Version

2.0.1

License

MIT + file LICENSE

Maintainer

Katie Birchard

Last Published

October 14th, 2024

Functions in rsyncrosim (2.0.1)

addRow

Add row(s) to a data.frame
chartOptionsXAxis

Modify the X Axis of a Chart
dateModified

Last date a SsimLibrary, Project, Scenario, or Folder was modified
delete

Delete SsimLibrary, Project, Scenario, Folder, Chart or Datasheet
datasheetSpatRaster

Retrieve spatial data from a SyncroSim Datasheet
datasheet

Retrieve a SyncroSim Datasheet
dependency

Get, set or remove Scenario dependency(s)
deleteLibrary

Delete Library
chartOptionsYAxis

Modify the Y axis of a Chart
command

SyncroSim console command
ignoreDependencies

Ignore dependencies for a Scenario
folder

Create or open a Folder
folderId

Retrieves folderId of SyncroSim Folder or Scenario
chartData

Sets the Chart type and axes
createCondaEnv

Create SyncroSim package conda environments
condaFilepath

Path to Conda installation folder
mergeDependencies

Merge dependencies for a Scenario
projectId

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

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

Installs Miniconda
installPackage

Adds package to SyncroSim Installation
progressBar

Sets the progress bar in the SyncroSim User Interface
name

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

SyncroSim Temporary Folder
runtimeDataFolder

SyncroSim Data Folder
info

Retrieves information about a library
description

Description of SsimLibrary, Project or Scenario
filepath

Retrieves the path to a SyncroSim object on disk
owner

Owner of a SsimLibrary, Project, or Scenario
project

Create or open Project(s)
rsyncrosim

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

Installed or available packages
removePackage

Removes SyncroSim package(s)
saveDatasheet

Save Datasheet(s)
scenario

Create or open Scenario(s)
scenarioId

Retrieves scenarioId of Scenario
printCmd

Retrieves printCmd setting of a Session
parentId

Retrieves the parent Scenario id or parent Folder id
runLog

Retrieves run log of result Scenario
run

Run scenarios
ssimEnvironment

SyncroSim Environment
ssimLibrary

Create or open a SsimLibrary
useConda

Conda configuration of a SsimLibrary
updateRunLog

Function to write to the SyncroSim run log
sqlStatement

Construct an SQLite query
silent

Silent status of SyncroSim Session
version

Retrieves SyncroSim version
session

Create or return SyncroSim Session
tempfilepath

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

Removes a package from SyncroSim installation
Scenario-class

SyncroSim Scenario class
backup

Backup a SsimLibrary
Project-class

SyncroSim Project class
Chart-class

SyncroSim Chart class
Session-class

SyncroSim Session class
addPackage

Add SyncroSim package(s)
SsimLibrary-class

SyncroSim Library class
Folder-class

SyncroSim Folder class
chart

Create or open a chart
chartDisagg

Disaggregates the Chart by a Y variable
chartId

Retrieves chartId of SyncroSim Chart
chartCriteria

Retrieves chart variables
chartErrorBar

Modify the error bars of a Chart
chartInclude

Add or remove values by column in a Chart
chartOptionsFont

Modifies the font settings for a Chart
chartOptionsLegend

Modifies the legend settings for a Chart
chartOptionsFormat

Modifies the font settings for a Chart