Package: rsyncrosim 2.0.2

Katie Birchard

rsyncrosim: The R Interface to 'SyncroSim'

'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/>).

Authors:Colin Daniel [aut], Josie Hughes [aut], Valentin Lucet [aut], Alex Embrey [aut], Katie Birchard [aut, cre], Leonardo Frid [aut], Tabitha Kennedy [aut], Shreeram Senthivasan [aut], ApexRMS [cph]

rsyncrosim_2.0.2.tar.gz
rsyncrosim_2.0.2.zip(r-4.5)rsyncrosim_2.0.2.zip(r-4.4)rsyncrosim_2.0.2.zip(r-4.3)
rsyncrosim_2.0.2.tgz(r-4.4-any)rsyncrosim_2.0.2.tgz(r-4.3-any)
rsyncrosim_2.0.2.tar.gz(r-4.5-noble)rsyncrosim_2.0.2.tar.gz(r-4.4-noble)
rsyncrosim_2.0.2.tgz(r-4.4-emscripten)rsyncrosim_2.0.2.tgz(r-4.3-emscripten)
rsyncrosim.pdf |rsyncrosim.html
rsyncrosim/json (API)
NEWS

# Install 'rsyncrosim' in R:
install.packages('rsyncrosim', repos = c('https://syncrosim.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/syncrosim/rsyncrosim/issues

On CRAN:

7.04 score 8 stars 207 scripts 319 downloads 1 mentions 78 exports 19 dependencies

Last updated 5 days agofrom:27b0f76b06. Checks:OK: 1 ERROR: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 19 2024
R-4.5-winERRORNov 19 2024
R-4.5-linuxERRORNov 19 2024
R-4.4-winERRORNov 19 2024
R-4.4-macERRORNov 19 2024
R-4.3-winERRORNov 19 2024
R-4.3-macERRORNov 19 2024

Exports:addPackageaddRowbackupchartChartchartCriteriachartDatachartDisaggchartErrorBarchartIdchartIncludechartOptionsFontchartOptionsFormatchartOptionsLegendchartOptionsXAxischartOptionsYAxiscommandcondaFilepathcondaFilepath<-createCondaEnvdatasheetdatasheetSpatRasterdateModifieddeletedeleteLibrarydependencydependency<-descriptiondescription<-filepathfolderFolderfolderIdfolderId<-ignoreDependenciesignoreDependencies<-infoinstallCondainstallPackagemergeDependenciesmergeDependencies<-namename<-ownerowner<-packagesparentIdprintCmdprogressBarprojectProjectprojectIdreadOnlyreadOnly<-removePackagerunrunLogruntimeDataFolderruntimeTempFoldersaveDatasheetscenarioScenarioscenarioIdsessionSessionsession<-silentsilent<-sqlStatementssimEnvironmentssimLibrarySsimLibrarytempfilepathuninstallPackageupdateRunLoguseCondauseConda<-version

Dependencies:bitbit64blobcachemclicpp11DBIfastmapgluegtoolslifecyclememoisepkgconfigplogrRcpprlangRSQLiteterravctrs

Readme and manuals

Help Manual

Help pageTopics
Add SyncroSim package(s)addPackage addPackage,character-method addPackage,SsimLibrary-method
Add row(s) to a data.frameaddRow addRow,data.frame-method
Backup a SsimLibrarybackup backup,character-method backup,SsimObject-method
Create or open a chartchart
SyncroSim Chart classChart Chart-class
Retrieves chart variableschartCriteria chartCriteria,SsimObject-method
Sets the 'Chart' type and axeschartData chartData,Chart-method
Disaggregates the 'Chart' by a Y variablechartDisagg chartDisagg,Chart-method
Modify the error bars of a 'Chart'chartErrorBar chartErrorBar,Chart-method
Retrieves chartId of SyncroSim ChartchartId chartId,character-method chartId,Chart-method
Add or remove values by column in a 'Chart'chartInclude chartInclude,Chart-method
Modifies the font settings for a 'Chart'chartOptionsFont chartOptionsFont,Chart-method
Modifies the font settings for a 'Chart'chartOptionsFormat chartOptionsFormat,Chart-method
Modifies the legend settings for a 'Chart'chartOptionsLegend chartOptionsLegend,Chart-method
Modify the X Axis of a 'Chart'chartOptionsXAxis chartOptionsXAxis,Chart-method
Modify the Y axis of a 'Chart'chartOptionsYAxis chartOptionsYAxis,Chart-method
SyncroSim console commandcommand
Path to Conda installation foldercondaFilepath condaFilepath,missingOrNULLOrChar-method condaFilepath,Session-method condaFilepath<- condaFilepath<-,character-method condaFilepath<-,Session-method
Create SyncroSim package conda environmentscreateCondaEnv createCondaEnv,ANY,character-method createCondaEnv,ANY,missingOrNULL-method createCondaEnv,ANY,Session-method
Retrieve a SyncroSim Datasheetdatasheet datasheet,character-method datasheet,list-method datasheet,SsimObject-method
Retrieve spatial data from a SyncroSim DatasheetdatasheetSpatRaster datasheetSpatRaster,character-method datasheetSpatRaster,list-method datasheetSpatRaster,Scenario-method datasheetSpatRaster,SsimObject-method
Last date a SsimLibrary, Project, Scenario, or Folder was modifieddateModified dateModified,character-method dateModified,Folder-method dateModified,Project-method dateModified,Scenario-method dateModified,SsimLibrary-method
Delete SsimLibrary, Project, Scenario, Folder, Chart or Datasheetdelete delete,character-method delete,SsimObject-method
Delete LibrarydeleteLibrary deleteLibrary,character-method deleteLibrary,SsimLibrary-method
Get, set or remove Scenario dependency(s)dependency dependency,character-method dependency,Scenario-method dependency<- dependency<-,Scenario-method
Description of SsimLibrary, Project or Scenariodescription description,character-method description,SsimObject-method description<- description<-,character-method description<-,SsimObject-method
Retrieves the path to a SyncroSim object on diskfilepath filepath,character-method filepath,Folder-method filepath,Session-method filepath,SsimObject-method
Create or open a Folderfolder
SyncroSim Folder classFolder Folder-class
Retrieves folderId of SyncroSim Folder or ScenariofolderId folderId,character-method folderId,Folder-method folderId,Scenario-method folderId<- folderId<-,Scenario-method
Ignore dependencies for a ScenarioignoreDependencies ignoreDependencies,character-method ignoreDependencies,Scenario-method ignoreDependencies<- ignoreDependencies<-,character-method ignoreDependencies<-,Scenario-method
Retrieves information about a libraryinfo info,SsimLibrary-method
Installs MinicondainstallConda installConda,character-method installConda,missingOrNULL-method installConda,Session-method
Adds package to SyncroSim InstallationinstallPackage installPackage,ANY,ANY,character-method installPackage,ANY,ANY,missingOrNULL-method installPackage,ANY,ANY,Session-method
Merge dependencies for a ScenariomergeDependencies mergeDependencies,character-method mergeDependencies,Scenario-method mergeDependencies<- mergeDependencies<-,character-method mergeDependencies<-,Scenario-method
Name of a SsimLibrary, Project, Scenario, Folder, or Chartname name,character-method name,Chart-method name,Folder-method name,Project-method name,Scenario-method name,SsimLibrary-method name<- name<-,character-method name<-,Chart-method name<-,Folder-method name<-,Project-method name<-,Scenario-method name<-,SsimLibrary-method
Owner of a SsimLibrary, Project, or Scenarioowner owner,character-method owner,Project-method owner,Scenario-method owner,SsimLibrary-method owner<- owner<-,character-method owner<-,SsimObject-method
Installed or available packagespackages packages,character-method packages,missingOrNULL-method packages,Session-method packages,SsimLibrary-method
Retrieves the parent Scenario id or parent Folder idparentId parentId,character-method parentId,Folder-method parentId,Scenario-method
Retrieves printCmd setting of a SessionprintCmd printCmd,missingOrNULLOrChar-method printCmd,Session-method
Sets the progress bar in the SyncroSim User InterfaceprogressBar
Create or open Project(s)project
SyncroSim Project classProject Project-class
Retrieves projectId of SyncroSim Project, Scenario, Folder, or ChartprojectId projectId,character-method projectId,Chart-method projectId,Folder-method projectId,Project-method projectId,Scenario-method
Read-only status of a SsimLibrary, Project, Scenario or FolderreadOnly readOnly,character-method readOnly,Chart-method readOnly,Folder-method readOnly,Project-method readOnly,Scenario-method readOnly,SsimLibrary-method readOnly<- readOnly<-,character-method readOnly<-,Chart-method readOnly<-,Folder-method readOnly<-,SsimObject-method
Removes SyncroSim package(s)removePackage removePackage,character-method removePackage,SsimLibrary-method
rsyncrosim: The R interface to SyncroSim: https://syncrosim.com/rsyncrosim-package rsyncrosim
Run scenariosrun run,character-method run,list-method run,SsimObject-method
Retrieves run log of result ScenariorunLog runLog,character-method runLog,Scenario-method
SyncroSim Data FolderruntimeDataFolder
SyncroSim Temporary FolderruntimeTempFolder
Save Datasheet(s)saveDatasheet saveDatasheet,character-method saveDatasheet,SsimObject-method
Create or open Scenario(s)scenario
SyncroSim Scenario classScenario Scenario-class
Retrieves scenarioId of ScenarioscenarioId scenarioId,character-method scenarioId,Scenario-method
Create or return SyncroSim Sessionsession session,Folder-method session,missingOrNULLOrChar-method session,SsimObject-method session<- session<-,NULLOrChar-method session<-,SsimObject-method
SyncroSim Session classSession Session-class
Silent status of SyncroSim Sessionsilent silent,missingOrNULLOrChar-method silent,Session-method silent<- silent<-,character-method silent<-,Session-method
Construct an SQLite querysqlStatement
SyncroSim EnvironmentssimEnvironment
Create or open a SsimLibraryssimLibrary ssimLibrary,missingOrNULLOrChar-method ssimLibrary,SsimObject-method
SyncroSim Library classSsimLibrary SsimLibrary-class
Retrieves the temporary file path to a SyncroSim object on disktempfilepath tempfilepath,character-method tempfilepath,Session-method tempfilepath,SsimObject-method
Removes a package from SyncroSim installationuninstallPackage uninstallPackage,ANY,ANY,character-method uninstallPackage,ANY,ANY,missingOrNULL-method uninstallPackage,ANY,ANY,Session-method
Function to write to the SyncroSim run logupdateRunLog
Conda configuration of a SsimLibraryuseConda useConda,character-method useConda,SsimLibrary-method useConda<- useConda<-,logical-method useConda<-,SsimLibrary-method
Retrieves SyncroSim versionversion version,character-method version,missingOrNULL-method version,Session-method