Flesh out documentation of key functions #25
Comments
thibautjombart
changed the title
Merged
joshwlambert
added a commit
that referenced
this issue
Sep 30, 2022
Merged
joshwlambert
added a commit
that referenced
this issue
Oct 5, 2022
* added Rmarkdown readme and rendered markdown readme from Rmd, WIP #29 * added render_readme workflow, fixes #29 * Added pkgdown, fixes #27 * fixed typo in render_readme.yml * fixed typo in render_readme.yml * removed incorrect dash in render_readme.yml * added MIT license badge to readme * updated documentation for epidist and extract_param, fixes #19 & #25 * added bug report, feature request and pull request templates * added code of conduct, fixes #31 * added contributing guidelines, fixes #32 * typo in contributing link * linting package including changed database colnames to snake case, changed argument from type to delay_dist and updated tests * removed suggestion of editing through github web from CONTRIBUTING.md * updated documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently the title of epidist is a bit vague, and the description very succinct: "
Parameter probability distribution by day". It would be helpful to provide context and explain when this is useful, what it can be used for, and possibly add a @detail section as needed. I would recommend checking this for all important user-facing functions. Functions to check include:The text was updated successfully, but these errors were encountered: