Skip to content

v5.2.0

Latest
Compare
Choose a tag to compare
@Felixmil Felixmil released this 31 Jul 09:12
· 19 commits to main since this release
dba1084

Breaking changes

  • {esqlabsR} now requires {ospsuite} version 12.1.0 or higher to benefit from
    embedded PK-Sim core files.

  • Function exportSteadyStateToXLS has been removed in favor of
    ospsuite::exportSteadyStateToXLS (#598)

  • Function sensitivitySpiderPlot overhauled with new parameters. yAxisType
    to toggle between percentand absolute values. xAxisScale and
    yAxisScale to set axis scales to log or lin. yAxisFacetScales to
    choose between free and fixed scales for y-axis. Further plot
    customization options through defaultPlotConfiguration (#632).

  • Function sensitivityTimeProfiles with new signature. Introduced parameters
    xAxisScale and yAxisScale to set axis scales to log or lin. More
    plot customization options through defaultPlotConfiguration as described
    in the documentation. Plots have improved color palette, scaling and legend
    colors (#669).

  • Function sensitivityTimeProfiles updated. Observed data (single or
    multiple DataSet objects) can now be added to the plots and will be
    included automatically in the outputPath if the dimensions are convertible
    (#674).

  • Function writeExcel() is no longer exported. (#672)

Major Changes

  • New sensitivityTornadoPlot function for generating tornado plots that
    evaluate the impact of parameter changes on sensitivity analysis outcomes.
    It utilizes parameterFactor to depict the scaling effects of parameter
    modifications. Provides plot customization options through
    defaultPlotConfiguration (#652).

  • New function writeParameterStructureToXLS to write a list of parameter
    paths, values, and units (e.g., imported using the readParametersFromXLS()
    function) to an Excel file. In contrast to exportParametersToXLS(), which
    writes an excel file for a list of Parameter objects, this function
    expects the parameter structure as used throughout the package.

Minor improvements and bug fixes

  • Function createScenarios gets a new argument stopIfParameterNotFound. If
    TRUE (default), a scenario will not be created and an error is thrown if
    any user-defined parameter (e.g., provided in Excel files) is not found in
    the simulation. If FALSE, non-existing parameters are ignored. (#559)

  • Constructor of a Scenario class gets a new argument
    stopIfParameterNotFound.

  • More explicit error is shown if x/yOffsetsUnit is not set when x/yOffset is
    defined.

  • Plotting functions have improved dynamic axis breaks, limits calculation, and
    labeling (#691).