useConda: Conda configuration of a SsimLibrary

In rsyncrosim: The R Interface to 'SyncroSim'

Conda configuration of a SsimLibrary

Description

Retrieves or sets the Conda configuration of a SsimLibrary. Note that in order to use conda environments, you will first need to ensure that the conda environment has been created for a given package. You can create the conda environment for a package using the createCondaEnv function.

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. 15, 2024, 1:06 a.m.