esqLABS / esqlabsR

Utility functions for modelling and simulation workflows within esqLABS organization
https://esqlabs.github.io/esqlabsR/
GNU General Public License v2.0
16 stars 2 forks source link

Add tornado plot #652

Closed rengelke closed 4 months ago

rengelke commented 4 months ago

New sensitivityTornadoPlot function #609 to visualize the results of sensitivity analysis. Each plot shows the effect of modifying parameters by a specific scaling factor (parameterFactor) and its reciprocal on specific model outputs. This visualization helps to assess the impact of parameter changes on the results, highlighting the model's sensitivity to these parameters.

@param sensitivityCalculation The SensitivityCalculation object returned by sensitivityCalculation(). @param outputPaths, parameterPaths, pkParameters A single or a vector of the output path(s), parameter path(s), and PK parameters to be displayed, respectively. If NULL, all included paths and parameters present in the supplied SensitivityCalculation object will be displayed in the visualization. @param parameterFactor Numeric; the scaling factor used to adjust parameters during sensitivity analysis used in the tornado plot. Both the parameterFactor and its reciprocal (1/parameterFactor) must be included in the variationRange specified in the sensitivityCalculation. Default is 0.1. @param defaultPlotConfiguration An object of class DefaultPlotConfiguration used to customize plot aesthetics.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 98.51852% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 85.56%. Comparing base (7508ad7) to head (fc4a366).

Files Patch % Lines
R/sensitivity-tornado-plot.R 98.42% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #652 +/- ## ========================================== + Coverage 84.68% 85.56% +0.88% ========================================== Files 28 29 +1 Lines 1913 2044 +131 ========================================== + Hits 1620 1749 +129 - Misses 293 295 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

PavelBal commented 4 months ago

@Laura-Villain @Felixmil @dlefaudeux Please review until Monday so @rengelke can proceed. Two reviews will be sufficient.