Move dispersion from parameter to summary statistic in DB and add dispersion to create_summary_stats()
#379
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… in data_dictionary
joshwlambert
force-pushed
the
disp_summary_stat
branch
from
0528b79
to
be0759f
Compare
|
Merging this PR even though one of the unit tests is failing as this will be fixed in an upcoming PR. Other GHA workflows have also failed since rebasing this branch but this is due to an issue with the workflow and independent of any changes made in this PR. |
This was referenced Sep 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR redefines the dispersion parameter as a summary statistic for probability distributions that do not use the dispersion parameter in usual parameterisations (e.g lognormal distributions). It is kept as a parameter for distributions that use dispersion as a standard parameter (e.g. negative binomial). This change is made to the parameter database (
parameters.json).The JSON schema (
data_dictionary.json) is enhanced by adding apropertyNameenumto make sure that summary statistics stored in the database are valid from a set of options.The
create_summary_stats()function is updated to includedispersionand dispersion uncertainty as arguments and in the output list. The function documentation is also updated.