ssimLibrary | R Documentation |
Creates or opens a SsimLibrary
object.
If summary = TRUE
, returns SsimLibrary summary info.
If summary = NULL
, returns SsimLibrary summary info if ssimObject is a SsimLibrary,
SsimLibrary object otherwise.
ssimLibrary(
name = NULL,
summary = NULL,
package = NULL,
session = NULL,
addon = NULL,
template = NULL,
forceUpdate = FALSE,
overwrite = FALSE,
useConda = NULL
)
## S4 method for signature 'SsimObject'
ssimLibrary(
name = NULL,
summary = NULL,
package = NULL,
session = NULL,
addon = NULL,
template = NULL,
forceUpdate = FALSE,
overwrite = FALSE,
useConda = NULL
)
## S4 method for signature 'missingOrNULLOrChar'
ssimLibrary(
name = NULL,
summary = NULL,
package = NULL,
session = NULL,
addon = NULL,
template = NULL,
forceUpdate = FALSE,
overwrite = FALSE,
useConda = NULL
)
name |
|
summary |
logical. Default is |
package |
character. The package type. Default is "stsim" |
session |
|
addon |
character or character vector. One or more addon packages. See
|
template |
character. Creates the SsimLibrary with the specified template (optional) |
forceUpdate |
logical. If |
overwrite |
logical. If |
useConda |
logical. If set to TRUE, then all packages associated with the Library will have their Conda environments created and Conda environments will be used during runtime.If set to FALSE, then no packages will have their Conda environments created and Conda environments will not be used during runtime. Default is NULL |
Example arguments:
If name is SyncroSim Project or Scenario: Returns the
SsimLibrary
associated with the Project or Scenario.
If name is NULL
: Create/open a SsimLibrary in the current working
directory with the filename SsimLibrary.ssim.
If name is a string: If string is not a valid path treat as filename in working directory. If no file suffix provided in string then add .ssim. Attempts to open a SsimLibrary of that name. If SsimLibrary does not exist creates a SsimLibrary of type package in the current working directory.
If given a name and a package: Create/open a SsimLibrary called name.ssim. Returns an error if the SsimLibrary already exists but is a different type of package.
Returns a SsimLibrary
object.
## Not run:
# Make sure packages are installed
addPackage("stsim")
addPackage("stsimsf")
# Create or open a SsimLibrary using the default Session
myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"))
# Create SsimLibrary using a specific Session
mySession <- session()
myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"),
session = mySession)
# Retrieve SsimLibrary properties
session(myLibrary)
# Load a SsimLibrary with addon package
myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"),
overwrite = TRUE, package = "stsim",
addon = "stsimsf")
# Create SsimLibrary from template
addPackage("helloworldSpatial")
mySession <- session()
myLibrary <- ssimLibrary(name = file.path(tempdir(), "mylib"),
session = mySession,
package = "helloworldSpatial",
template = "example-library",
overwrite = TRUE,
forceUpdate = TRUE)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.