Specify probability distribution in as_epidist()
#335
Merged
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
…iew vignette, relates #310
joshwlambert
added
documentation
adamkucharski
approved these changes
Jun 18, 2024
Bisaloo
reviewed
Jun 19, 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 addresses #310 by extending
as_epidist()to accept aprob_distargument. This is then read byepireview_to_epidist()and can be used to parameterise a distribution if parameters or summary statistics are available but a probability distribution is not specified.A section has been added to the
data_from_epireview.Rmdvignette to outline how this feature works and to warn users against using this feature improperly.Unit tests have been added to check
prob_distpassed via...inas_epidist()works as expected and Faye et al. (2015) has been added toreferences.JSONas it is cited indata_from_epireview.Rmd.