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

  • Automatically structure your data: SyncroSim ties together your existing data from disparate formats, such as Excel, CSV, and GeoTIFF. No database is required – SyncroSim automatically structures your data files for you.

  • Use your data to make predictions: SyncroSim allows you to chain together “models” – including existing off-the-shelf programs and scripts written in languages such as R, Python and C# – to transform your data into predictions.

  • Engage decision makers: No longer are forecasts delivered by analysts as static reports. Through its unique, easy-to-use interface, SyncroSim allows non-technical users to define, run and track their own “what-if” scenarios using the original data and models.

  • Go big: SyncroSim is specifically designed to handle big data, including support for cloud computing, multiprocessing, and large rasters.

About rsyncrosim

The rsyncrosim R package allows you to script and run SyncroSim operations in R.

Installation

Windows:

  • Download the latest latest release of the Windows rsyncrosim package as a zip file (note that the package is not yet available from CRAN)

  • Install the package zip file in R. For example in RStudio, open the Install Packages window, select Package Archive File (for Install from) and rsyncrosim_X.X.X.zip (for Package archive), where X.X.X is the version of the package.

  • Run the demonstration script and/or view the package documentation (both also found in the doc folder of the package once installed)

Linux:

Download and install the latest release of the rsyncrosim package.

Getting Started

Copy Link

Version

Install

install.packages('rsyncrosim')

Monthly Downloads

309

Version

1.2.4

License

MIT + file LICENSE

Issues

0

Pull Requests

0

Stars

10

Forks

6

Maintainer

Colin Daniel

Last Published

June 4th, 2020

Functions in rsyncrosim (1.2.4)

backup

Backup an SsimLibrary.
delete

Delete library, project, scenario, datasheet
owner

The owner of a SsimLibrary/Project/Scenario.
scenarioId

The scenarioId of a scenario.
mergeDependencies

Merge Dependencies for a Scenario.
session<-

Set a SyncroSim session.
owner<-

Set the owner of an SsimLibrary/Project/Scenario.
mergeDependencies<-

Merge Dependencies for a Scenario.
dateModified

The last date a SsimLibrary/Project/Scenario was modified.
envReportProgress

Reports progress for a SyncroSim simulation
deleteBreakpoint

Delete a Scenario breakpoint.
basePackage

Installed base packages
name

The name of a SyncroSim library, project or scenario.
runLog

The run log of a result Scenario
deletePackage

Deletes a package
dependency

Set or remove Scenario dependency(s), or get existing dependencies.
silent<-

Set silent property of a Session
session

Creates or returns a SyncroSim session.
name<-

Set ssimObject name.
run

Run scenarios
breakpoint

Lists the breakpoints for a Scenario.
addPackageFile

Adds a package to SyncroSim
deleteModule

Delete module or modules
printCmd

Get printCmd of a Session.
scenario

Create or open one or more Scenarios.
saveDatasheet

Save datasheet(s)
project

Create or open a project or projects.
datasheetRaster

Get spatial inputs or outputs from a Scenario(s).
enableAddon

Enable addon or addons.
package

Installed or available packages
parentId

The parent scenario id of a SyncroSim Scenario.
datasheet

Get a datasheet
disableAddon

Disable addon or addons.
command

SyncroSim console command
filepath

The path to a SyncroSim object on disk
model

Installed models
envInputFolder

SyncroSim DataSheet Input Folder
info

Information about an library
module

Installed modules
envOutputFolder

SyncroSim DataSheet Output Folder
description

Description of an SsimLibrary/Project/Scenario.
description<-

Set the description of an SsimLibrary/Project/Scenario.
readOnly

Read-only status of an SsimLibrary/Project/Scenario.
projectId

The projectId of a SyncroSim project or scenario.
envTempFolder

SyncroSim Temporary Folder
ssimEnvironment

SyncroSim Environment.
ssimUpdate

Apply updates
rsyncrosim

rsyncrosim: The R interface to SyncroSim: http://syncrosim.com/
readOnly<-

Set the read/write status of an SsimLibrary/Project/Scenario.
tempfilepath

The temporary file path to a SyncroSim object on disk
silent

Check if a Session is silent
version

The SyncroSim version
updatePackage

Update Package
sqlStatement

Construct an SQLite query
ssimLibrary

Create or open a library.
addPackage

Adds a package to SyncroSim
addBreakpoint

Add a Scenario breakpoint.
addon

addon(s) of an SsimLibrary or Session
Scenario-class

SyncroSim Scenario class
Project-class

SyncroSim Project class
Session-class

SyncroSim Session class
addModule

Add module
addRow

Add row(s) to a dataframe.
SsimLibrary-class

SyncroSim Library class