Replace list_distributions() with parameter_tbl()
#321
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
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 #227 and #245 by replacing the
list_distributions()function withparameter_tbl(). This should be a more intuitive function name for those looking to get a table of the parameters in the {epiparameter} database. The<data.frame>returned byparameter_tbl()now also includes the sample size for the parameter entry (#227) and the pathogen (#245).The table output by
parameter_tbl()is of the class<p_tbl>, which wraps the<tbl>class from the {pillar} package, itself a subclass of<data.frame>, this is to utilise the nicer printing of<data.frame>s offered by the {pillar} package (used by {tibble}). This requires taking on {pillar} as a package dependency.The
READMEhas been updated to include an example of theparameter_tbl()function.Tests and documentation have been updated where relevant.