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

package scaffolding #38

Closed
10 of 11 tasks
wibeasley opened this issue Jan 1, 2020 · 2 comments
Closed
10 of 11 tasks

package scaffolding #38

wibeasley opened this issue Jan 1, 2020 · 2 comments
Assignees

Comments

@wibeasley
Copy link
Contributor

wibeasley commented Jan 1, 2020

As I've expressed with a few tweaks:

I'd (like to) modify some of the package's structure to more closely resemble the approach described in Hadley's R Packages book (and the tidyverse style guide). The first reason is because I think it's a good approach and has worked well for me in the past. A second reason is that this approach is documented better and more coherently than any other approach --therefore it will be easier for someone else to modify or become maintainer in the future.

But this won't be a major overhaul. Most of the important elements of the existing package follow this book's approach.

The changes come in two sets: the little guys that come before adding a test suite (issues #4 & #29) and those that come after the test suite (which includes some of the recently accumulating issues like #33, #35, & #37).

Before test suite

  • Rproj

  • update Roxygen

  • updates to .Rbuildignore and .gitignore files.

  • move daily development off the master and to the dev branch

  • update person entries in DESCRIPTION file

  • semantic versioning for dev versions (e.g., x.x.x.9001)

  • remove date from DESCRIPTION file

  • (re)connect codecov which currently reads 0%. (@pdurbin, as an admin of this GitHub org, you'll probably see my request for additional permissions granted to Codecov. I requested it only for this single public repo.)

    image (click the image for the live staus)

After test suite and functional changes

I'm flexible if anyone has other ideas.

@wibeasley wibeasley self-assigned this Jan 1, 2020
wibeasley added a commit that referenced this issue Jan 1, 2020
wibeasley added a commit that referenced this issue Jan 1, 2020
wibeasley added a commit that referenced this issue Jan 1, 2020
@leeper, I believe thesee are the correct modifications, according to [CRAN](https://journal.r-project.org/archive/2012/RJ-2012-009/RJ-2012-009.pdf) and [Hadley](http://r-pkgs.had.co.nz/description.html).  Tell me if you think I've misinterpreted something.

@pdurbin, please check your ORCID number.  I found it [here](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/TJCLKP)

ref #38
wibeasley added a commit that referenced this issue Jan 1, 2020
@pdurbin
Copy link
Member

pdurbin commented Jan 2, 2020

my request for additional permissions granted to Codecov

Yes, you may have seen that @whorka approved this request earlier today. Thanks for working on the tests! 🎉

@wibeasley wibeasley mentioned this issue Jan 3, 2020
wibeasley added a commit that referenced this issue Jan 3, 2020
wibeasley added a commit that referenced this issue Jan 4, 2020
@wibeasley wibeasley mentioned this issue Jan 3, 2021
@kuriwaki
Copy link
Member

This tidyverse style package scaffolding seems largely complete. The issues in the create_* functions will get dealt with using the same scaffolding. Thanks @wibeasley !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants