Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

serofoi 1.0.2 release #265

Merged
merged 224 commits into from
Dec 10, 2024
Merged

serofoi 1.0.2 release #265

merged 224 commits into from
Dec 10, 2024

Conversation

ntorresd
Copy link
Member

@ntorresd ntorresd commented Dec 9, 2024

This PR corresponds to the release of serofoi 1.0.2. The most important changes had been reviewed by the development team in the development branch. See for instance:

serofoi 1.0.2

New features

  • Serological surveys simulation functionalities

    • Introduce enhanced data simulation functionalities to support a broader range of use cases for serosurvey analysis.
    • Add a dedicated vignette for data simulation to guide users on simulating data for serosurveys.
  • Enables the implementation of a wide variety of new models

    • Add forward random walk age-varying models with uniform and normal priors.
    • Improves previous implementation of forward random walk time-varying models.
    • Enables prior distributions specifications by means of package specific functions like sf_normal() and sf_uniform().
    • Support for seroreversion rate estimation for all models with uniform and normal priors.

Breaking changes

  • Replaced old modelling and visualization functions, making Bayesian model selection and specification more flexible.
  • New models and functionalities include constant, time-varying, and age-varying models, as well as options for estimating seroreversion rates.
  • Updated the R-hat convergence threshold for model convergence diagnostics to R-hat<1.01,
    following Vehtari et al. (2021).

Minor changes

  • Remove the simdata_* datasets from the package and replaced them with code-based simulation in vignettes.
  • Add missing examples to exported functions
  • Add missing documentation entries

Internal changes

ntorresd and others added 30 commits November 20, 2024 21:20
- use same ylim in foi plots for better readability
- add environment cleanup at the end of each example
- use data simulation functionalities of the package to simulate the
datasets in `foi_models.Rmd` examples
- use same chunk structure in modelling to validate results
- overall cleanup of the vignette
- Replace `prob_infected.stan` by two separate files for each
type of model
- Slight change to parameter order in `prob_infected_calculate`
…ation

- Change how `stan_data` is constructed depending on type of model
- Specify default behavior by type of model
- Use `age` for age-varying models and `years` in time-varying
models in
    - `get_foi_central_estimates`
    - `plot_foi`
    - `plot_rhats`
Copy link

github-actions bot commented Dec 9, 2024

This pull request:

  • Adds 2 new dependencies (direct and indirect)
  • Adds 1 new system dependencies
  • Removes 1 existing dependencies (direct and indirect)
  • Removes 1 existing system dependencies

(Note that results may be inacurrate if you branched from an outdated version of the target branch.)

@ntorresd ntorresd marked this pull request as ready for review December 9, 2024 06:55
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a608a0d) to head (4be70e3).

Additional details and impacted files
@@             Coverage Diff              @@
##             main      #265       +/-   ##
============================================
+ Coverage   42.83%   100.00%   +57.16%     
============================================
  Files           4         6        +2     
  Lines         747      1015      +268     
============================================
+ Hits          320      1015      +695     
+ Misses        427         0      -427     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zmcucunuba
Copy link
Member

zmcucunuba commented Dec 10, 2024

Hello. Seem ready for release!

@zmcucunuba zmcucunuba closed this Dec 10, 2024
@ntorresd ntorresd reopened this Dec 10, 2024
Copy link

This pull request:

  • Adds 2 new dependencies (direct and indirect)
  • Adds 1 new system dependencies
  • Removes 1 existing dependencies (direct and indirect)
  • Removes 1 existing system dependencies

(Note that results may be inacurrate if you branched from an outdated version of the target branch.)

Copy link
Member

@zmcucunuba zmcucunuba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready for release

@ntorresd ntorresd merged commit 6e09927 into main Dec 10, 2024
17 checks passed
@ntorresd ntorresd deleted the dev branch December 10, 2024 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants