The R Interface to 'SyncroSim'
Overview
'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/).
Breaking changes:
Bug fixes:
- Improved column matching when populating datasheets to treat column names case-insensitively, reducing mismatches
- When a case-insensitive match is found, sheet column names are aligned to the canonical names for consistent output
- Preserved previous behaviors for ID assignment and full-selection imports to maintain compatibility
- Restrict renaming of "ID"→"Id" to primary key and foreign key columns only, avoiding unintended renames in other column
- Bug fix to allow overwriting datasheet with empty dataframe
- Updates to datasheet and datasheetSpatRaster to fail if filterColumn doesn't exist in datasheet
- Bug fix to prevent duplicate records when specifying multiple scenarios within the same datasheet function call
Minor improvements and fixes:
Show all changes in 2.1.13Hide the rest of the changes in 2.1.13
- Updated package dependencies
- Fixed links for classes in documentation (scenario, project, library, folder)
- datasheet filterValue argument now accepts vectors to allow filtering on multiple values at once
Deprecations:
- datasheetSpatRaster() is now deprecated; use datasheet() instead to obtain raster file paths
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-09
- NOTE12 OK, 1 NOTE2026-06-08
- OK14 OK2026-03-10
Documentation
- Help pages
- 73 (1 internal)includes a package overview page
- Examples that run
- 2%1 run in a plain check · 64 never run
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 98%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 93%
- Median days to close, 50 most recently updated closed issues
- 253
- Median days to close, 50 most recently updated closed PRs
- 0
7 development-tooling and community-health practices detected across 4 families in the upstream repository
Checks run against github.com/syncrosim/rsyncrosim on 2026-10-18.
GitHub Pages site last deployed 2026-05-12 · The repository has a site deploy workflow
pkgdown site last built 2026-03-10, before release 2.1.13 (2026-03-24)
Dependencies
Code & Tests
People & History
Previously maintained by Katie Birchard (1.4.9 to 2.1.9) and Colin Daniel (1.2.4 to 1.4.2).
Pick two releases to compare their code metrics.
- RR 4.6.0 released · 2026-04-24
- 2.1.13Latest
- 2.1.92025-10-14 · diff ↗ ·
removed 6 exports
Chart, Folder, Project, Scenario, Session, SsimLibraryadded 2 exports
compact, restore - 2.1.2
- RR 4.5.0 released · 2025-04-11
- 2.0.12024-10-15 · diff ↗ ·
removed 28 exports
autogentags<-, addBreakpoint, addModule, addPackageFile, addon, autogentags, basePackage, breakpoint, datasheetRaster, deleteBreakpoint, deleteModule, deletePackage, disableAddon, enableAddon, envBeginSimulation, envEndSimulation, envInputFolder, envOutputFolder, envReportProgress, envStepSimulation, envTempFolder, model, module, package, runtimeInputFolder, runtimeOutputFolder, ssimUpdate, updatePackageadded 20 exports
dependency<-, Chart, chart, chartCriteria, chartData, chartDisagg, chartErrorBar, chartId, chartInclude, chartOptionsFont, chartOptionsFormat, chartOptionsLegend, chartOptionsXAxis, chartOptionsYAxis, createCondaEnv, deleteLibrary, installPackage, packages, runtimeDataFolder, uninstallPackage - RR 4.4.0 released · 2024-04-24
- 1.5.0
- 1.4.92023-10-07 · diff ↗ ·
added 7 exports
folderId<-, published<-, Folder, datasheetSpatRaster, folder, folderId, published - RR 4.3.0 released · 2023-04-21
- 1.4.22022-10-08 · diff ↗ ·
added 6 exports
condaFilepath<-, useConda<-, condaFilepath, installConda, updateRunLog, useConda - RR 4.2.0 released · 2022-04-22
- 1.3.22021-10-28 · diff ↗ ·
added 6 exports
addModule, progressBar, removePackage, runtimeInputFolder, runtimeOutputFolder, runtimeTempFolder - RR 4.1.0 released · 2021-05-18
- 1.2.92021-02-16 · diff ↗ ·
added 4 exports
autogentags<-, ignoreDependencies<-, autogentags, ignoreDependencies - 1.2.42020-06-04
Show 1 earlier eventHide 1 earlier event
- RR 4.0.0 released · 2020-04-24
Package metadata
- First published
- 2020-06-04
- Total releases
- 10 / 6 yrs
- License
- MIT + file LICENSE OSI
- Download size
- 148 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("rsyncrosim")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-21, which the citation names so these numbers can be found later. More on citing and the projects behind them.