data package draft post

[apreshill]

Raw R Markdown:

https://github.com/rbind/apreshill/blob/data-package-post/content/post/2018-06-29-data-package.Rmd

Can be viewed here!

https://5b8d90fab13fb108849d1b3a--apreshill.netlify.com/post/data-package/

@ismayc @isteves

[ismayc]

Cool! Can you direct us to the Rmd file so we can make tweaks/add suggestions too?

[ismayc]

Sounds like a good blogpost follow-up is in order when the package is on CRAN too? 😄

[isteves]

Neat, thanks for sharing! Btw, if you haven't seen Tomas and Emil's usethis blogposts, they're worth checking out.

A few initial comments/questions:

1. In the next release, devtools will become a "meta-package" (like the tidyverse) that will install usethis and friends as a bundle (see conscious uncoupling). Is this TMI or is it worth mentioning in the post? This means that eventually, users can install everything with install.packages("devtools") and possibly also load everything with library(devtools). Currently, both usethis::use_* and devtools::use_* work, but eventually devtools::use_* will be deprecated.

2. In Windows, I get an error when trying to use create_from_github.

This RStudio Community thread discusses some of these git/R issues on Windows and Mac, and provides good troubleshooting tips. This workaround from Jenny worked for me and may be worth mentioning (or at least linking to):

cred <- git2r::cred_ssh_key(
  publickey = "~/../.ssh/id_rsa.pub",
  privatekey = "~/../.ssh/id_rsa"
)
use_github(credentials = cred)
# or in this case, create_from_github("apreshill/bakeoff", credentials = cred)

Also, Tomas/Emil both use use_git and use_github, which saves the step of visiting github.com. Perhaps it's also worth using it in this post? (Though I do like seeing this alternative workflow!)

3. 😀 nice example of purrr::walk! I never know when to use it, so it's great to see it in action!

4. Rather than using roxygen2::roxygenise, I typically use devtools::document, which is really just a wrapper around the former. My preference would be to stick with devtools simply because it makes one less package that the reader has to think about. In any case, it already shows up in a screenshot!

Looking forward to our chat later today!

[ismayc]

@ismayc will add TL; DR