The R Interface to 'SyncroSim'


[Up] [Top]

Documentation for package ‘rsyncrosim’ version 1.2.9

Help Pages

A B C D E F I M N O P R S T U V

-- A --

addBreakpoint Add a Scenario breakpoint.
addBreakpoint-method Add a Scenario breakpoint.
addModule Add module
addModule-method Add module
addon addon(s) of an SsimLibrary or Session
addon-method addon(s) of an SsimLibrary or Session
addPackage Adds a package to SyncroSim
addPackage-method Adds a package to SyncroSim
addPackageFile Adds a package to SyncroSim
addPackageFile-method Adds a package to SyncroSim
addRow Add row(s) to a dataframe.
addRow-method Add row(s) to a dataframe.
autogentags Auto Generation Tags for a Scenario.
autogentags-method Auto Generation Tags for a Scenario.
autogentags<- Auto Generation Tags for a Scenario.
autogentags<--method Auto Generation Tags for a Scenario.

-- B --

backup Backup a SsimLibrary.
backup-method Backup a SsimLibrary.
basePackage Installed base packages
basePackage-method Installed base packages
breakpoint Lists the breakpoints for a Scenario.
breakpoint-method Lists the breakpoints for a Scenario.

-- C --

command SyncroSim console command

-- D --

datasheet Get a datasheet
datasheet-method Get a datasheet
datasheetRaster Get spatial inputs or outputs from a Scenario(s).
datasheetRaster-method Get spatial inputs or outputs from a Scenario(s).
dateModified The last date a SsimLibrary/Project/Scenario was modified.
dateModified-method The last date a SsimLibrary/Project/Scenario was modified.
delete Delete library, project, scenario, datasheet
delete-method Delete library, project, scenario, datasheet
deleteBreakpoint Delete a Scenario breakpoint.
deleteBreakpoint-method Delete a Scenario breakpoint.
deleteModule Delete module or modules
deleteModule-method Delete module or modules
deletePackage Deletes a package
deletePackage-method Deletes a package
dependency Set or remove Scenario dependency(s), or get existing dependencies.
dependency-method Set or remove Scenario dependency(s), or get existing dependencies.
description Description of an SsimLibrary/Project/Scenario.
description-method Description of an SsimLibrary/Project/Scenario.
description<- Set the description of an SsimLibrary/Project/Scenario.
description<--method Set the description of an SsimLibrary/Project/Scenario.
disableAddon Disable addon or addons.
disableAddon-method Disable addon or addons.

-- E --

enableAddon Enable addon or addons.
enableAddon-method Enable addon or addons.
envBeginSimulation Reports progress for a SyncroSim simulation
envEndSimulation Reports progress for a SyncroSim simulation
envInputFolder SyncroSim DataSheet Input Folder
envOutputFolder SyncroSim DataSheet Output Folder
envReportProgress Reports progress for a SyncroSim simulation
envStepSimulation Reports progress for a SyncroSim simulation
envTempFolder SyncroSim Temporary Folder

-- F --

filepath The path to a SyncroSim object on disk
filepath-method The path to a SyncroSim object on disk

-- I --

ignoreDependencies Ignore Dependencies for a Scenario.
ignoreDependencies-method Ignore Dependencies for a Scenario.
ignoreDependencies<- Ignore Dependencies Datafeeds for a Scenario.
ignoreDependencies<--method Ignore Dependencies Datafeeds for a Scenario.
info Information about an library
info-method Information about an library

-- M --

mergeDependencies Merge Dependencies for a Scenario.
mergeDependencies-method Merge Dependencies for a Scenario.
mergeDependencies<- Merge Dependencies for a Scenario.
mergeDependencies<--method Merge Dependencies for a Scenario.
model Installed models
model-method Installed models
module Installed modules
module-method Installed modules

-- N --

name The name of a SyncroSim library, project or scenario.
name-method The name of a SyncroSim library, project or scenario.
name<- Set ssimObject name.
name<--method Set ssimObject name.

-- O --

owner The owner of a SsimLibrary/Project/Scenario.
owner-method The owner of a SsimLibrary/Project/Scenario.
owner<- Set the owner of an SsimLibrary/Project/Scenario.
owner<--method Set the owner of an SsimLibrary/Project/Scenario.

-- P --

package Installed or available packages
package-method Installed or available packages
parentId The parent scenario id of a SyncroSim Scenario.
parentId-method The parent scenario id of a SyncroSim Scenario.
printCmd Get printCmd of a Session.
printCmd-method Get printCmd of a Session.
Project SyncroSim Project class
project Create or open a project or projects.
Project-class SyncroSim Project class
projectId The projectId of a SyncroSim project or scenario.
projectId-method The projectId of a SyncroSim project or scenario.

-- R --

readOnly Read-only status of a SsimLibrary/Project/Scenario.
readOnly-method Read-only status of a SsimLibrary/Project/Scenario.
readOnly<- Set the read/write status of a SsimLibrary/Project/Scenario.
readOnly<--method Set the read/write status of a SsimLibrary/Project/Scenario.
rsyncrosim rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/
run Run scenarios
run-method Run scenarios
runLog The run log of a result Scenario
runLog-method The run log of a result Scenario

-- S --

saveDatasheet Save datasheet(s)
saveDatasheet-method Save datasheet(s)
Scenario SyncroSim Scenario class
scenario Create or open one or more Scenarios.
Scenario-class SyncroSim Scenario class
scenarioId The scenarioId of a scenario.
scenarioId-method The scenarioId of a scenario.
Session SyncroSim Session class
session Creates or returns a SyncroSim session.
Session-class SyncroSim Session class
session-method Creates or returns a SyncroSim session.
session<- Set a SyncroSim session.
session<--method Set a SyncroSim session.
silent Check if a Session is silent
silent-method Check if a Session is silent
silent<- Set silent property of a Session
silent<--method Set silent property of a Session
sqlStatement Construct an SQLite query
ssimEnvironment SyncroSim Environment
SsimLibrary SyncroSim Library class
ssimLibrary Create or open a library
SsimLibrary-class SyncroSim Library class
ssimLibrary-method Create or open a library
ssimUpdate Apply updates
ssimUpdate-method Apply updates

-- T --

tempfilepath The temporary file path to a SyncroSim object on disk
tempfilepath-method The temporary file path to a SyncroSim object on disk

-- U --

updatePackage Update Package
updatePackage-method Update Package

-- V --

version The SyncroSim version
version-method The SyncroSim version