The R Interface to 'SyncroSim'
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘rsyncrosim’ version 1.5.0
Help Pages
A B C D E F I M N O P R S T U V
| rsyncrosim-package | rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/ |
-- A --
| addBreakpoint | Add a Scenario breakpoint |
| addBreakpoint-method | Add a Scenario breakpoint |
| addon | Addon(s) installed in SsimLibrary or Session |
| addon-method | Addon(s) installed in SsimLibrary or Session |
| addPackage | Adds package to SyncroSim Installation |
| addPackage-method | Adds package to SyncroSim Installation |
| addRow | Add row(s) to a data.frame |
| addRow-method | Add row(s) to a data.frame |
| 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 |
| breakpoint | Breakpoints for a Scenario |
| breakpoint-method | Breakpoints for a Scenario |
-- C --
| command | SyncroSim console command |
| condaFilepath | Path to Conda installation folder |
| condaFilepath-method | Path to Conda installation folder |
| condaFilepath<- | Path to Conda installation folder |
| condaFilepath<--method | Path to Conda installation folder |
-- D --
| datasheet | Retrieve a SyncroSim Datasheet |
| datasheet-method | Retrieve a SyncroSim Datasheet |
| datasheetRaster | Retrieve spatial data from a SyncroSim Datasheet |
| datasheetRaster-method | Retrieve spatial data from a SyncroSim Datasheet |
| datasheetSpatRaster | Retrieve spatial data from a SyncroSim Datasheet |
| datasheetSpatRaster-method | Retrieve spatial data from a SyncroSim Datasheet |
| dateModified | Last date a SsimLibrary, Project or Scenario was modified |
| dateModified-method | Last date a SsimLibrary, Project or Scenario was modified |
| delete | Delete SsimLibrary, Project, Scenario, Datasheet |
| delete-method | Delete SsimLibrary, Project, Scenario, Datasheet |
| deleteBreakpoint | Delete a Scenario breakpoint |
| deleteBreakpoint-method | Delete a Scenario breakpoint |
| dependency | Get, set or remove Scenario dependency(s) |
| dependency-method | Get, set or remove Scenario dependency(s) |
| description | Description of SsimLibrary, Project or Scenario |
| description-method | Description of SsimLibrary, Project or Scenario |
| description<- | Description of SsimLibrary, Project or Scenario |
| description<--method | Description of SsimLibrary, Project or Scenario |
| disableAddon | Disable addon package(s) |
| disableAddon-method | Disable addon package(s) |
-- E --
| enableAddon | Enable addon package(s) |
| enableAddon-method | Enable addon package(s) |
-- F --
| filepath | Retrieves the path to a SyncroSim object on disk |
| filepath-method | Retrieves the path to a SyncroSim object on disk |
| Folder | SyncroSim Folder class |
| folder | Create or open a Folder |
| Folder-class | SyncroSim Folder class |
| folderId | Retrieves folderId of SyncroSim Folder or Scenario |
| folderId-method | Retrieves folderId of SyncroSim Folder or Scenario |
| folderId<- | Retrieves folderId of SyncroSim Folder or Scenario |
| folderId<--method | Retrieves folderId of SyncroSim Folder or Scenario |
-- I --
| ignoreDependencies | Ignore dependencies for a Scenario |
| ignoreDependencies-method | Ignore dependencies for a Scenario |
| ignoreDependencies<- | Ignore dependencies for a Scenario |
| ignoreDependencies<--method | Ignore dependencies for a Scenario |
| info | Retrieves information about a library |
| info-method | Retrieves information about a library |
| installConda | Installs Miniconda |
| installConda-method | Installs Miniconda |
-- 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 |
-- N --
| name | Name of a SsimLibrary, Project, Scenario, or Folder |
| name-method | Name of a SsimLibrary, Project, Scenario, or Folder |
| name<- | Name of a SsimLibrary, Project, Scenario, or Folder |
| name<--method | Name of a SsimLibrary, Project, Scenario, or Folder |
-- O --
| owner | Owner of a SsimLibrary, Project, Scenario, or Folder |
| owner-method | Owner of a SsimLibrary, Project, Scenario, or Folder |
| owner<- | Owner of a SsimLibrary, Project, Scenario, or Folder |
| owner<--method | Owner of a SsimLibrary, Project, Scenario, or Folder |
-- P --
| package | Installed or available packages |
| package-method | Installed or available packages |
| parentId | Retrieves the parent Scenario id or parent Folder id |
| parentId-method | Retrieves the parent Scenario id or parent Folder id |
| printCmd | Retrieves printCmd setting of a Session |
| printCmd-method | Retrieves printCmd setting of a Session |
| progressBar | Sets the progress bar in the SyncroSim User Interface |
| Project | SyncroSim Project class |
| project | Create or open Project(s) |
| Project-class | SyncroSim Project class |
| projectId | Retrieves projectId of SyncroSim Project, Scenario, or Folder |
| projectId-method | Retrieves projectId of SyncroSim Project, Scenario, or Folder |
-- R --
| readOnly | Read-only status of a SsimLibrary, Project, Scenario or Folder |
| readOnly-method | Read-only status of a SsimLibrary, Project, Scenario or Folder |
| readOnly<- | Read-only status of a SsimLibrary, Project, Scenario or Folder |
| readOnly<--method | Read-only status of a SsimLibrary, Project, Scenario or Folder |
| removePackage | Removes package from SyncroSim installation |
| removePackage-method | Removes package from SyncroSim installation |
| rsyncrosim | rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/ |
| run | Run scenarios |
| run-method | Run scenarios |
| runLog | Retrieves run log of result Scenario |
| runLog-method | Retrieves run log of result Scenario |
| runtimeInputFolder | SyncroSim DataSheet Input Folder |
| runtimeOutputFolder | SyncroSim DataSheet Output Folder |
| runtimeTempFolder | SyncroSim Temporary Folder |
-- S --
| saveDatasheet | Save Datasheet(s) |
| saveDatasheet-method | Save Datasheet(s) |
| Scenario | SyncroSim Scenario class |
| scenario | Create or open Scenario(s) |
| Scenario-class | SyncroSim Scenario class |
| scenarioId | Retrieves scenarioId of Scenario |
| scenarioId-method | Retrieves scenarioId of Scenario |
| Session | SyncroSim Session class |
| session | Create or return SyncroSim Session |
| Session-class | SyncroSim Session class |
| session-method | Create or return SyncroSim Session |
| session<- | Create or return SyncroSim Session |
| session<--method | Create or return SyncroSim Session |
| silent | Silent status of SyncroSim Session |
| silent-method | Silent status of SyncroSim Session |
| silent<- | Silent status of SyncroSim Session |
| silent<--method | Silent status of SyncroSim Session |
| sqlStatement | Construct an SQLite query |
| ssimEnvironment | SyncroSim Environment |
| SsimLibrary | SyncroSim Library class |
| ssimLibrary | Create or open a SsimLibrary |
| SsimLibrary-class | SyncroSim Library class |
| ssimLibrary-method | Create or open a SsimLibrary |
| ssimUpdate | Apply updates |
| ssimUpdate-method | Apply updates |
-- T --
| tempfilepath | Retrieves the temporary file path to a SyncroSim object on disk |
| tempfilepath-method | Retrieves the temporary file path to a SyncroSim object on disk |
-- U --
| updatePackage | Update Package |
| updatePackage-method | Update Package |
| updateRunLog | Function to write to the SyncroSim run log |
| useConda | Conda configuration of a SsimLibrary |
| useConda-method | Conda configuration of a SsimLibrary |
| useConda<- | Conda configuration of a SsimLibrary |
| useConda<--method | Conda configuration of a SsimLibrary |
-- V --
| version | Retrieves SyncroSim version |
| version-method | Retrieves SyncroSim version |