removeSimulationFromCache: Removes a simulation from simulations cache.

View source: R/utilities-simulation.R

removeSimulationFromCacheR Documentation

Removes a simulation from simulations cache.

Description

Removes a simulation from simulations cache.

Usage

removeSimulationFromCache(simulation)

Arguments

simulation

Simulation to be removed from the cache

Value

TRUE if the simulation was cached and could be removed from cache. FALSE otherwise, usually indicating that the specific simulation was not cached.

Examples

simPath <- system.file("extdata", "simple.pkml", package = "ospsuite")
sim1 <- loadSimulation(simPath)
sim2 <- loadSimulation(simPath, loadFromCache = FALSE, addToCache = FALSE)

removeSimulationFromCache(sim1) # returns TRUE
removeSimulationFromCache(sim2) # returns FALSE

Open-Systems-Pharmacology/OSPSuite-R documentation built on Feb. 14, 2025, 4:48 p.m.