Learn R Programming

rsyncrosim

The R interface to SyncroSim

About SyncroSim

SyncroSim is an open science tool for organizing tabular and spatial data, running geospatial simulation code, and visualizing model results. Its flexible framework supports the integration of code across multiple scripting languages and the use and creation of customizable SyncroSim packages, allowing you to tailor the platform to your specific needs.

For more details, please consult the SyncroSim online documentation.

About rsyncrosim

rsyncrosim is an open-source R package that leverages the SyncroSim command-line interface to simplify scripting model workflows for SyncroSim in R. This R package provides functions for building models from scratch, running those models, and accessing both spatial and tabular model outputs. The rsyncrosim package is designed to work with any SyncroSim package.

A key feature of the rsyncrosim package is its seamless integration with SyncroSim Studio, allowing you to interactively explore and validate your models in the user interface as you step through your R code. Additionally, rsyncrosim facilitates the creation of a permanent, reproducible record of the entire modeling workflow – including 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

1,362

Version

2.1.9

License

MIT + file LICENSE

Maintainer

Katie Birchard

Last Published

October 14th, 2025

Functions in rsyncrosim (2.1.9)

addPackage

Add SyncroSim package(s)
chartCriteria

Retrieves chart variables
chartInclude

Add or remove values by column in a Chart-class
chartDisagg

Disaggregates the Chart-class by a Y variable
chartOptionsLegend

Modifies the legend settings for a Chart-class
chartData

Sets the Chart-class type and axes
chartErrorBar

Modify the error bars of a Chart-class
chartOptionsFont

Modifies the font settings for a Chart-class
chartId

Retrieves chartId of SyncroSim Chart
chartOptionsFormat

Modifies the font settings for a Chart-class
createCondaEnv

Create SyncroSim package conda environments
dependency

Get, set or remove Scenario dependencies
condaFilepath

Path to Conda installation folder
compact

Compacts a SsimLibrary
folder

Create or open a Folder
filepath

Retrieves the path to a SyncroSim object on disk
mergeDependencies

Merge dependencies for a Scenario
packages

Installed or available packages
datasheet

Retrieve a SyncroSim Datasheet
parentId

Retrieves the parent Scenario id or parent Folder id
installPackage

Adds package to SyncroSim Installation
chartOptionsXAxis

Modify the X Axis of a Chart-class
datasheetSpatRaster

Retrieve spatial data from a SyncroSim Datasheet
chartOptionsYAxis

Modify the Y axis of a Chart-class
command

SyncroSim console command
owner

Owner of a SsimLibrary, Project, or Scenario
name

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

Retrieves scenarioId of Scenario
description

Description of SsimLibrary, Project or Scenario
project

Create or open Project(s)
restore

Restore Library
projectId

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

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

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

Create or open Scenario(s)
saveDatasheet

Save datasheet
ignoreDependencies

Ignore dependencies for a Scenario
run

Run scenarios
folderId

Retrieves folderId of SyncroSim Folder or Scenario
progressBar

Sets the progress bar in the SyncroSim User Interface
printCmd

Retrieves printCmd setting of a Session
useConda

Conda configuration of a SsimLibrary
updateRunLog

Function to write to the SyncroSim run log
signIn

Signs in to SyncroSim
delete

Delete Project, Scenario, Folder, Chart or Datasheet
info

Retrieves information about a library
deleteLibrary

Delete Library
signOut

Signs out of SyncroSim
runLog

Retrieves run log of result Scenario
uninstallPackage

Removes a package from SyncroSim installation
tempfilepath

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

Create or open a SsimLibrary
ssimEnvironment

SyncroSim Environment
session

Create or return SyncroSim Session
viewProfile

Display SyncroSim profile
version

Retrieves SyncroSim version
removePackage

Removes SyncroSim package(s)
readOnly

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

Installs Miniforge or Miniconda
runtimeDataFolder

SyncroSim Data Folder
sqlStatement

Construct an SQLite query
runtimeTempFolder

SyncroSim Temporary Folder
silent

Silent status of SyncroSim Session
Session-class

SyncroSim Session class
Scenario-class

SyncroSim Scenario class
backup

Backup a SsimLibrary
Folder-class

SyncroSim Folder class
addRow

Add row(s) to a data.frame
SsimLibrary-class

SyncroSim Library class
Project-class

SyncroSim Project class
chart

Create or open a chart
Chart-class

SyncroSim Chart class