ropensci / ozunconf17

Website for 2017 rOpenSci Ozunconf
http://ozunconf17.ropensci.org/
24 stars 6 forks source link

Check list procedures for R-related tasks #41

Open rdpeng opened 7 years ago

rdpeng commented 7 years ago

The basic idea here is to develop check lists for R-related tasks in situations where it can be a bit tricky to get things setup/completed. The origin of this came from my experience teaching people to build packages in R/RStudio. I found there were a few "gotchas" that often caused confusion that could have been avoided if only I had remembered them (e.g. path to package cannot have spaces in the name).

Given that it can (a) be difficult to remember every little detail of certain processes and (b) the processes tend to change/evolve over time, it is nice to have a simple list to refer to that can be updated as needed. For example, my R package "pre-flight" check list is something that I have referred to numerous times both in my own work and when teaching the topic. It's an activity that I do just uncommonly enough that I can't remember all the details whenever I do it. In addition to helping people remember things, check lists can simultaneously serve as useful summaries of "lessons learned" about a given topic.

Some quick ideas that I could think up were

For many of these topics I imagine there would be existing blog posts, help files, vignettes, etc. describing what to do. The idea in that case would be to distill the essential information into an abbreviated format so that someone could quickly reference it and get started. For some specific topics, there might be multiple blogs/tutorials and the check list could serve to harmonize what is out there.

jonocarroll commented 7 years ago

Even collecting together all of the useful blog posts/tutorials and curating them would be a great start.

As a two-way street option for the packages side, I'll share an excerpt of my chapter on writing packages (this will probably be a blog post down the track); I'd love to know what's missing from this and what's particularly helpful: https://www.dropbox.com/s/6y69oipygasn39q/chapter10_excerpt.html?dl=0