update vignette for efficient calculations #598
Conversation
|
|
||
|
|
||
| ## Running one or more simulations multiple times in a loop |
There was a problem hiding this comment.
I have the feeling that this was not the right caption? I did not see a section where you describe a loop. I propose a new caption.
There was a problem hiding this comment.
I would only use batch if it was in a loop such as an algorithm (PI, sensitivity etc..) .For a finite number of run, I am not sure that this is really required.....
| library(ospsuite) | ||
| simFilePath <- system.file("extdata", "Aciclovir.pkml", package = "ospsuite") | ||
|
|
||
| # We create two different instances of the same simulation to illustrate the usage. | ||
| # We load the simulation for which the batches will be created | ||
| sim1 <- loadSimulation(simFilePath, loadFromCache = FALSE) |
There was a problem hiding this comment.
Actually, no two sims needed here.
There was a problem hiding this comment.
Yes this was just to say that you can have multiple simulations and not only one simulation
| parametersOrPaths = c("Aciclovir|Molecular weight") | ||
| ) | ||
|
|
||
| simulationBatches <- list(simBatch1, simBatch2) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I split the code into smaller chunks with some info in between.
|
|
||
| # So far, we created 2 simulation batches, one with 3 parameter sets and the |
There was a problem hiding this comment.
I find it a bit too technical, with memory allocation etc..
| simulationResults <- runSimulations(simulations = sim) | ||
| print(simulationResults) | ||
| The results in this case will be a named list of `SimulationResults`-object , i.e. one for each simulation. | ||
| The names of the entries of the list are the ids of the simulation to which the results |
There was a problem hiding this comment.
Added some info about ids.
Codecov Report
@@ Coverage Diff @@
## develop #598 +/- ##
========================================
Coverage 90.27% 90.27%
========================================
Files 75 75
Lines 1831 1831
========================================
Hits 1653 1653
Misses 178 178 Continue to review full report at Codecov.
|
| # from the environment and the allocated memory cleared. | ||
| # This will be done automatically when the R session is terminated. | ||
| rm(simBatch1) | ||
| rm(simBatch2) | ||
| ``` | ||
|
|
||
| Usage of `SimulationBatch` is recommended for advanced scenarios where simulations expected to be run hundreds of times and where each second that can be spared will impact the performance significantly. |
There was a problem hiding this comment.
I would not do this as it is MD and therefor will be formatted automatically. Why do you think we need to add CR manually?
|
Fine with me |
@msevestre Nice description, indeed! I corrected some typos and added some explanation to the vignette, let me know what do you think.