Package: rsyncrosim 2.0.1
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:
rsyncrosim_2.0.1.tar.gz
rsyncrosim_2.0.1.zip(r-4.5)rsyncrosim_2.0.1.zip(r-4.4)rsyncrosim_2.0.1.zip(r-4.3)
rsyncrosim_2.0.1.tgz(r-4.4-any)rsyncrosim_2.0.1.tgz(r-4.3-any)
rsyncrosim_2.0.1.tar.gz(r-4.5-noble)rsyncrosim_2.0.1.tar.gz(r-4.4-noble)
rsyncrosim_2.0.1.tgz(r-4.4-emscripten)rsyncrosim_2.0.1.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')) |
Bug tracker:https://github.com/syncrosim/rsyncrosim/issues
Last updated 24 days agofrom:2395bfafc0. Checks:OK: 1 ERROR: 6. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Oct 14 2024 |
| R-4.5-win | ERROR | Oct 14 2024 |
| R-4.5-linux | ERROR | Oct 14 2024 |
| R-4.4-win | ERROR | Oct 14 2024 |
| R-4.4-mac | ERROR | Oct 14 2024 |
| R-4.3-win | ERROR | Oct 14 2024 |
| R-4.3-mac | ERROR | Oct 14 2024 |
Exports:addPackageaddRowbackupchartChartchartCriteriachartDatachartDisaggchartErrorBarchartIdchartIncludechartOptionsFontchartOptionsFormatchartOptionsLegendchartOptionsXAxischartOptionsYAxiscommandcondaFilepathcondaFilepath<-createCondaEnvdatasheetdatasheetSpatRasterdateModifieddeletedeleteLibrarydependencydependency<-descriptiondescription<-filepathfolderFolderfolderIdfolderId<-ignoreDependenciesignoreDependencies<-infoinstallCondainstallPackagemergeDependenciesmergeDependencies<-namename<-ownerowner<-packagesparentIdprintCmdprogressBarprojectProjectprojectIdreadOnlyreadOnly<-removePackagerunrunLogruntimeDataFolderruntimeTempFoldersaveDatasheetscenarioScenarioscenarioIdsessionSessionsession<-silentsilent<-sqlStatementssimEnvironmentssimLibrarySsimLibrarytempfilepathuninstallPackageupdateRunLoguseCondauseConda<-version
Dependencies:bitbit64blobcachemclicpp11DBIfastmapgluegtoolslifecyclememoisepkgconfigplogrRcpprlangRSQLiteterravctrs
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Add SyncroSim package(s) | addPackage addPackage,character-method addPackage,SsimLibrary-method |
| Add row(s) to a data.frame | addRow addRow,data.frame-method |
| Backup a SsimLibrary | backup backup,character-method backup,SsimObject-method |
| Create or open a chart | chart |
| SyncroSim Chart class | Chart Chart-class |
| Retrieves chart variables | chartCriteria chartCriteria,SsimObject-method |
| Sets the 'Chart' type and axes | chartData chartData,Chart-method |
| Disaggregates the 'Chart' by a Y variable | chartDisagg chartDisagg,Chart-method |
| Modify the error bars of a 'Chart' | chartErrorBar chartErrorBar,Chart-method |
| Retrieves chartId of SyncroSim Chart | chartId 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 command | command |
| Path to Conda installation folder | condaFilepath condaFilepath,missingOrNULLOrChar-method condaFilepath,Session-method condaFilepath<- condaFilepath<-,character-method condaFilepath<-,Session-method |
| Create SyncroSim package conda environments | createCondaEnv createCondaEnv,ANY,character-method createCondaEnv,ANY,missingOrNULL-method createCondaEnv,ANY,Session-method |
| Retrieve a SyncroSim Datasheet | datasheet datasheet,character-method datasheet,list-method datasheet,SsimObject-method |
| Retrieve spatial data from a SyncroSim Datasheet | datasheetSpatRaster datasheetSpatRaster,character-method datasheetSpatRaster,list-method datasheetSpatRaster,Scenario-method datasheetSpatRaster,SsimObject-method |
| Last date a SsimLibrary, Project, Scenario, or Folder was modified | dateModified dateModified,character-method dateModified,Folder-method dateModified,Project-method dateModified,Scenario-method dateModified,SsimLibrary-method |
| Delete SsimLibrary, Project, Scenario, Folder, Chart or Datasheet | delete delete,character-method delete,SsimObject-method |
| Delete Library | deleteLibrary 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 Scenario | description description,character-method description,SsimObject-method description<- description<-,character-method description<-,SsimObject-method |
| Retrieves the path to a SyncroSim object on disk | filepath filepath,character-method filepath,Folder-method filepath,Session-method filepath,SsimObject-method |
| Create or open a Folder | folder |
| SyncroSim Folder class | Folder Folder-class |
| Retrieves folderId of SyncroSim Folder or Scenario | folderId folderId,character-method folderId,Folder-method folderId,Scenario-method folderId<- folderId<-,Scenario-method |
| Ignore dependencies for a Scenario | ignoreDependencies ignoreDependencies,character-method ignoreDependencies,Scenario-method ignoreDependencies<- ignoreDependencies<-,character-method ignoreDependencies<-,Scenario-method |
| Retrieves information about a library | info info,SsimLibrary-method |
| Installs Miniconda | installConda installConda,character-method installConda,missingOrNULL-method installConda,Session-method |
| Adds package to SyncroSim Installation | installPackage installPackage,ANY,ANY,character-method installPackage,ANY,ANY,missingOrNULL-method installPackage,ANY,ANY,Session-method |
| Merge dependencies for a Scenario | mergeDependencies mergeDependencies,character-method mergeDependencies,Scenario-method mergeDependencies<- mergeDependencies<-,character-method mergeDependencies<-,Scenario-method |
| Name of a SsimLibrary, Project, Scenario, Folder, or Chart | name 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 Scenario | owner owner,character-method owner,Project-method owner,Scenario-method owner,SsimLibrary-method owner<- owner<-,character-method owner<-,SsimObject-method |
| Installed or available packages | packages packages,character-method packages,missingOrNULL-method packages,Session-method packages,SsimLibrary-method |
| Retrieves the parent Scenario id or parent Folder id | parentId parentId,character-method parentId,Folder-method parentId,Scenario-method |
| Retrieves printCmd setting of a Session | printCmd printCmd,missingOrNULLOrChar-method printCmd,Session-method |
| Sets the progress bar in the SyncroSim User Interface | progressBar |
| Create or open Project(s) | project |
| SyncroSim Project class | Project Project-class |
| Retrieves projectId of SyncroSim Project, Scenario, Folder, or Chart | projectId projectId,character-method projectId,Chart-method projectId,Folder-method projectId,Project-method projectId,Scenario-method |
| Read-only status of a SsimLibrary, Project, Scenario or Folder | readOnly 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 scenarios | run run,character-method run,list-method run,SsimObject-method |
| Retrieves run log of result Scenario | runLog runLog,character-method runLog,Scenario-method |
| SyncroSim Data Folder | runtimeDataFolder |
| SyncroSim Temporary Folder | runtimeTempFolder |
| Save Datasheet(s) | saveDatasheet saveDatasheet,character-method saveDatasheet,SsimObject-method |
| Create or open Scenario(s) | scenario |
| SyncroSim Scenario class | Scenario Scenario-class |
| Retrieves scenarioId of Scenario | scenarioId scenarioId,character-method scenarioId,Scenario-method |
| Create or return SyncroSim Session | session session,Folder-method session,missingOrNULLOrChar-method session,SsimObject-method session<- session<-,NULLOrChar-method session<-,SsimObject-method |
| SyncroSim Session class | Session Session-class |
| Silent status of SyncroSim Session | silent silent,missingOrNULLOrChar-method silent,Session-method silent<- silent<-,character-method silent<-,Session-method |
| Construct an SQLite query | sqlStatement |
| SyncroSim Environment | ssimEnvironment |
| Create or open a SsimLibrary | ssimLibrary ssimLibrary,missingOrNULLOrChar-method ssimLibrary,SsimObject-method |
| SyncroSim Library class | SsimLibrary SsimLibrary-class |
| Retrieves the temporary file path to a SyncroSim object on disk | tempfilepath tempfilepath,character-method tempfilepath,Session-method tempfilepath,SsimObject-method |
| Removes a package from SyncroSim installation | uninstallPackage uninstallPackage,ANY,ANY,character-method uninstallPackage,ANY,ANY,missingOrNULL-method uninstallPackage,ANY,ANY,Session-method |
| Function to write to the SyncroSim run log | updateRunLog |
| Conda configuration of a SsimLibrary | useConda useConda,character-method useConda,SsimLibrary-method useConda<- useConda<-,logical-method useConda<-,SsimLibrary-method |
| Retrieves SyncroSim version | version version,character-method version,missingOrNULL-method version,Session-method |