For consideration: standard package structure and roxygen2 docs - Githubissues

CDC-DNPAO / CDCAnthro

10 stars 6 forks source link

For consideration: standard package structure and roxygen2 docs #4

Open beansrowning opened 1 year ago

beansrowning commented 1 year ago

I took a gander at the package a had a few minutes to spare this afternoon, so I decided to restructure some things.

For your consideration, should it be helpful.

Changes

Used standard package structure to make it easier to maintain, track code changes
- Added benefit that installation is now really simple with remotes::install_github("CDC-DNPAO/CDCAnthro")
Updated install instructions in README
Updated documents, NAMESPACE to use roxygen2 documentation framework, which is also a bit easier to work with than manually writing out docs, namespace imports manually

rossfarrugia commented 9 months ago

This PR is great @beansrowning - thanks!

@CDC-DNPAO we can talk through this over a call as using such a standard package structure makes things easier for users, and we can create a website for your package via using pkgdown. The contributors we'll connect in here via pharmaverse could help to take this contribution further.