Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial fully functioning package #11

Merged
merged 67 commits into from
Jan 4, 2023
Merged

Conversation

pratikunterwegs
Copy link
Member

@pratikunterwegs pratikunterwegs commented Dec 7, 2022

This PR is from a branch off tim (by @thimotei), and makes these changes over that branch, and over main:

  1. Standard package infrastructure - NAMESPACE, DESCRIPTION, Rbuildignore etc. (by @thimotei), and some extra package infrastructure - GHA workflows, more linter options, link to Codecov (by @pratikunterwegs);
  2. Adds testing infrastructure with high test coverage and a GHA workflow for code coverage,
  3. Adds the Ebola 1976 outbreak data to the package, simplifying the examples,
  4. Moves the ebola CFR analysis script to the README, and uses a .Rmd README,
  5. Adds input checking to most functions,
  6. Simplifies some functions (e.g. static_cfr) to return named vectors rather than dataframes,
  7. Maintains functionality of format_cfr_neatly to work with named vectors where changed,
  8. Removes the epiparameter, reshape2, and lubridate direct dependencies; epiparameter is now suggested, and data.table is added as more useful than reshape2 and lubridate while still reducing one dependency,
  9. Adds revised function documentation.
  10. Keeps the existing covid-19 USA example, but using new functions rolling_cfr() and new plotting function.

@pratikunterwegs
Copy link
Member Author

Thanks @adamkucharski and @Bisaloo for your input - I've made a few changes to sort the technical issues, but the potential issue with the CFR correctness remains. I'm not able to determine where any error might be as this is primarily an adaptation of Tim's code. Happy to add more tests for algorithmic correctness if these could be suggested, and that might help tackle the issue.

@pratikunterwegs
Copy link
Member Author

Refreshing this review thread so we can merge this added functionality into main

R/rolling_cfr.R Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request quality control Related to adding tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants