rsyncrosim (version 1.2.4)

session: Creates or returns a SyncroSim session.

Description

Methods to create or return a Syncrosim session.

Usage

session(x = NULL, silent = TRUE, printCmd = FALSE)
# S4 method for missingOrNULLOrChar
session(x = NULL, silent = TRUE, printCmd = FALSE)
# S4 method for SsimObject
session(x = NULL, silent = TRUE, printCmd = FALSE)

Arguments

x

Character or SsimObject. An optional path to the SyncroSim installation.

silent

Logical. Applies only if x is a path or NULL. If TRUE, warnings from the console are ignored. Otherwise they are printed.

printCmd

Logical. Applies only if x is a path or NULL. If TRUE, arguments passed to the SyncroSim console are also printed. Helpful for debugging. FALSE by default.

Value

A SyncroSim Session object.

Examples

# NOT RUN {
# Create Session
temp_dir <- tempdir()
mySession <- session()
myLibrary <- ssimLibrary(name = file.path(temp_dir,"testlib"), session = mySession)

filepath(mySession) # Lists the folder location of syncrosim session
version(mySession) # Lists the version of syncrosim session
package(mySession) # Dataframe of the packages installed with this version of syncrosim.
basePackage(mySession) # Dataframe of the base packages installed with this version of syncrosim.
# }
# NOT RUN {
# }