useConda: Conda configuration of a SsimLibrary

useCondaR Documentation

Conda configuration of a SsimLibrary

Description

Retrieves or sets the Conda configuration of a SsimLibrary.

Usage

useConda(ssimObject)

## S4 method for signature 'character'
useConda(ssimObject)

## S4 method for signature 'SsimLibrary'
useConda(ssimObject)

useConda(ssimObject) <- value

## S4 replacement method for signature 'logical'
useConda(ssimObject) <- value

## S4 replacement method for signature 'SsimLibrary'
useConda(ssimObject) <- value

Arguments

ssimObject

SsimLibrary object

value

logical for whether to use Conda environments for the given SyncroSim Library. If set to TRUE, then Conda environments will be used. If set to FALSE, then Conda environments will not be used during runtime.

Value

Logical: whether Conda environments will be used during runtime for the given SsimLibrary

Examples

## Not run: 
# Set up a SyncroSim Session, SsimLibrary
mySession <- session()

# Retrieve Conda configuration status of the SsimLibrary
useConda(myLibrary)

# Set the Conda configuration of the SyncroSim Library
useConda(myLibrary) <- TRUE

# Only use Conda with the specified SyncroSim packages
useConda(myLibrary) <- "helloworld"

# Only use Conda with multiple specified SyncroSim packages
useConda(myLibrary) <- c("helloworld", "stsim")

## End(Not run)


rsyncrosim documentation built on Oct. 7, 2023, 9:08 a.m.