session | R Documentation |
Methods to create or return a SyncroSim Session
.
session(x = NULL, silent = TRUE, printCmd = FALSE, condaFilepath = NULL) ## S4 method for signature 'missingOrNULLOrChar' session(x = NULL, silent = TRUE, printCmd = FALSE, condaFilepath = NULL) ## S4 method for signature 'SsimObject' session(x = NULL, silent = TRUE, printCmd = FALSE, condaFilepath = NULL) session(ssimObject) <- value ## S4 replacement method for signature 'NULLOrChar' session(ssimObject) <- value ## S4 replacement method for signature 'SsimObject' session(ssimObject) <- value
x |
character or SsimObject. Path to SyncroSim installation. If |
silent |
logical. Applies only if x is a path or |
printCmd |
logical. Applies only if x is a path or |
condaFilepath |
string. Gets or sets the path to the
Conda installation folder. Can be used to direct SyncroSim to a custom
Conda installation. If |
ssimObject |
|
value |
|
In order to avoid problems with SyncroSim version compatibility and SsimLibrary
updating, the new Session must have the same filepath as the Session of the
SsimObject
e.g. filepath(value)==filepath(session(ssimObject))
.
Therefore, the only time when you will need to set a new SyncroSim Session is if you
have updated the SyncroSim software and want to update an existing SsimObject
to use the new software.
A SyncroSim Session
object.
# Specify file path and name of new SsimLibrary myLibraryName <- file.path(tempdir(), "testlib") # Set up a SyncroSim Session, SsimLibrary, and Project mySession <- session() myLibrary <- ssimLibrary(name = myLibraryName, session = mySession) myProject <- project(myLibrary, project = "Definitions") # Lists the folder location of SyncroSim Session filepath(mySession) # Lists the version of SyncroSim Session version(mySession) # Data frame of the packages installed with this version of SyncroSim package(mySession) # Data frame of the base packages installed with this version of SyncroSim package(mySession, installed = "BASE") # Set a new SyncroSim Session for the SyncroSim Project session(myProject) <- session(x = filepath(session(myProject)))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.