Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Yes, two breaking changes are introduced in this PR:
The use of chunks is a breaking change allowing users to specify prior knowledge about the force-of-infection by assigning constant values of the force-of-infection to specific time intervals. The default behavior is chunk_size=1, which recovers previous results.
Now the user can specify the initial location and scale parameters of the distributions used in the stan files by means of foi_location and foi_scale parameters in fit_seromodel. The interpretation of these parameters may vary depending on the specified model. To recover previous results, users should use:
Please check if the PR fulfills these requirements
[x] I have read the CONTRIBUTING guidelines
[ ] A new item has been added to
NEWS.md
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
[x] Checks have been run locally and pass
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) This PR:
What is the current behavior? (You can also link to an open issue here)
Currently, one value of the force-of-infection is estimated for every year in the time spanned by the serosurvey.
or explicitly specifying the chunk structure:
chunk_size=1
, which recovers previous results.foi_location
andfoi_scale
parameters infit_seromodel
. The interpretation of these parameters may vary depending on the specified model. To recover previous results, users should use:tv_normal_log model
fit_seromodel( serodata = serodata, foi_model = "tv_normal", foi_location = -6, foi_scale = 4, ... )