saveDatasheet | R Documentation |
Saves a datasheet to a SsimLibrary
, Project
, or
Scenario
.
saveDatasheet(ssimObject, data, name = NULL, append = NULL, force = FALSE)
## S4 method for signature 'character'
saveDatasheet(ssimObject, data, name = NULL, append = NULL, force = FALSE)
## S4 method for signature 'SsimObject'
saveDatasheet(ssimObject, data, name = NULL, append = NULL, force = FALSE)
ssimObject |
|
data |
data.frame. The datasheet to load |
name |
character. The name of the datasheet to be saved |
append |
logical. If |
force |
logical. If datasheet scope is Project/SsimLibrary, and |
About the 'append' argument:
A Datasheet is a VALIDATION SOURCE if its data can be used to validate column values in a different Datasheet.
The append
argument will be ignored if the Datasheet is a validation
source and has a Project scope. In this case the data will be MERGED.
Invisibly returns a vector or list of logical values for each
input: TRUE
upon success (i.e.successful save) and FALSE
upon failure.
## Not run:
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")
# Set the SyncroSim Session, SsimLibrary, Project, and Scenario
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName,
session = mySession,
packages = "helloworldSpatial")
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")
# Get all Datasheet info
myDatasheets <- datasheet(myScenario)
# Get a specific Datasheet
myDatasheet <- datasheet(myScenario, name = "helloworldSpatial_RunControl")
# Modify Datasheet
myDatasheet$MaximumTimestep <- 10
# Save Datasheet
saveDatasheet(ssimObject = myScenario,
data = myDatasheet,
name = "helloworldSpatial_RunControl")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.