Link to "Enhancing Reproducibility and Collaboration via Management of R Package Cohorts" paper

gmbecker / switchr

An R package for managing and seamlessly switching between sets of installed R packages.

59 stars 6 forks source link

Link to "Enhancing Reproducibility and Collaboration via Management of R Package Cohorts" paper #16

Open daattali opened 3 years ago

daattali commented 3 years ago

The current documentation consists only of one vignette which isn't very in depth. From the package vignette I wasn't able to learn how to create a manifest file (the publishManifest() function). The paper at Journal of Stat Software has more information and as a new user I found it much more useful https://www.jstatsoft.org/article/view/v082i01

gmbecker commented 3 years ago

I think the paper does a lot of things that preclude it from being a vignette (mostly hitting the internet), but I can look into that. Do you think a link to it at the beginning of the vignette or somewhere in the documentation would help if the paper itself being a vignette isn't easily doable?

daattali commented 3 years ago

A link in the README and vignette would be the low hanging fruit here.

A higher hanging fruit would be... less fun and more work :p Writing the README/vignette from a new user's perspective, focusing on how you use this package, with less details about the technical implementations and more focus on usage. The journal paper is a good source for the deeper technical aspects IMO.