GofTaskSettings | R Documentation |
R6 class defining properties of time profiles and residuals plot task settings
ospsuite.reportingengine::TaskSettings
-> GofTaskSettings
referenceData
Data results obtained by TimeProfilesAndResiduals task corresponding to referencePopulation
includeReferenceData
logical defining if reference population should be included in time profiles and residual plots when applicable
outputSelections
is a subset of paths of all outputs belonging to a simulation set, to be used to generate a plot with only selected outputs
new()
Create a GofTaskSettings
object
GofTaskSettings$new( taskName = AllAvailableTasks$plotTimeProfilesAndResiduals, outputSelections = NULL, statisticsType = NULL )
taskName
name of the task using the settings
outputSelections
subset of simulationSet outputs to be used in GoF plot
statisticsType
Statistics summarizing time profile simulated data
A new GofTaskSettings
object
setStatistics()
Set statistics used in population time profiles and residuals plots
GofTaskSettings$setStatistics( statisticsType = NULL, y = NULL, ymin = NULL, ymax = NULL, yCaption = NULL, rangeCaption = NULL )
statisticsType
Name of statistics type as defined in enum StatisticsTypes
y
Function or function name for middle values statistics
ymin
Function or function name for min values statistics
ymax
Function or function name for max values statistics
yCaption
Legend caption for middle values statistics
rangeCaption
Legend caption for range values statistics
\dontrun{ # Set the statistics as geometric mean workflow$plotTimeProfilesAndResiduals$settings$setStatistics( statisticsType = StatisticsTypes$`Geometric mean` ) # Set the legend caption displayed for range workflow$plotTimeProfilesAndResiduals$settings$setStatistics( statisticsType = StatisticsTypes$`Geometric mean`, rangeCaption = "90% population range" ) }
getStatistics()
Get statistics used in population time profiles and residuals plots
GofTaskSettings$getStatistics()
\dontrun{ # Get the statistics of time profiles task workflow$plotTimeProfilesAndResiduals$settings$getStatistics() }
clone()
The objects of this class are cloneable with this method.
GofTaskSettings$clone(deep = FALSE)
deep
Whether to make a deep clone.
## ------------------------------------------------
## Method `GofTaskSettings$setStatistics`
## ------------------------------------------------
## Not run:
# Set the statistics as geometric mean
workflow$plotTimeProfilesAndResiduals$settings$setStatistics(
statisticsType = StatisticsTypes$`Geometric mean`
)
# Set the legend caption displayed for range
workflow$plotTimeProfilesAndResiduals$settings$setStatistics(
statisticsType = StatisticsTypes$`Geometric mean`,
rangeCaption = "90% population range"
)
## End(Not run)
## ------------------------------------------------
## Method `GofTaskSettings$getStatistics`
## ------------------------------------------------
## Not run:
# Get the statistics of time profiles task
workflow$plotTimeProfilesAndResiduals$settings$getStatistics()
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.