Release 2.0.0

[rengelke]

This release introduces significant enhancements and new features to the ospsuite.parameteridentification package:

Breaking Changes:

• Now requires {ospsuite} version 12.0 or later for improved functionality.
  • Configuration of the objective function in PIConfiguration is streamlined through objectiveFunctionOptions, allowing direct specification of parameters such as objectiveFunctionType and residualWeightingMethod.

Major Changes:

• Introduced calculateCostMetrics() to advance model evaluation capabilities, configurable via PIConfiguration.
• Launched the error-calculation and optimization-algorithms vignettes to guide users through error model methodologies and optimization algorithm selection.
• Added a comprehensive user-guide vignette, detailing the setup process for parameter identification tasks.
• New plot.modelCost() function for enhanced visualization of model evaluation metrics.
• Documentation has undergone a complete overhaul for better clarity and user guidance.
• Unit tests have been extensively revised, boosting test coverage from 67% to 85%.

Minor Improvements and Fixes:

• Improved error handling mechanisms ensure the presence of required simulation objects, enhancing the robustness of ParameterIdentification tasks.
• calculateCostMetrics() now provides a more detailed results summary, improving insights into model evaluation.
• README file has been updated and converted to .rmd format, providing clearer installation instructions and package information.
• Introduced validateIsOption() to validate user-configured options against predefined constraints.
• Default optimization algorithm options are now automatically accessed from respective packages if not defined in PIConfiguration.
• CI/CD pipeline enhancements have been implemented to streamline development and deployment processes.
• Addressed several bugs, enhancing overall package stability and performance.

Contributors: @rengelke, @PavelBal, @FelixMil, @svavil

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.77%. Comparing base (2830b25) to head (3a5d8ae).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #124 +/- ## ======================================= Coverage 84.77% 84.77% ======================================= Files 10 10 Lines 762 762 ======================================= Hits 646 646 Misses 116 116 ```

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

[Felixmil]

Perfect ! Can be merged.

• [x] Once merged is done, you can execute usethis::use_github_release() from the main branch, on Rstudio. It will open github in a browser tab and you can create a release.

• [x] Once this is done, you can run usethis::pr_finish() to clean the branch.

• [x] Then, run usethis::pr_init("back-to-dev"), usethis::use_dev_version(), accept commit suggestions and finally: usethis::pr_push().

[Felixmil]

@rengelke release was created (see here), use the checklist above for next steps :)

[PavelBal]

Thank you guys, this is a big one!