Rtistic: A package-by-numbers repo
Last winter, I attended a holiday party at a “paint-and-sip” venue. For those unfamiliar, “paint-and-sip” is a semi-trendy cottage industry offering evenings of music, wine, and a guided painting activity. For example, my group painted sasquatch on a snowy winter’s eve:
As often happens, this completely unrelated thing set me thinking about R. What made painting fun when we lacked the talent and experience to excel, when it almost surely wouldn’t turn out very well, and when “failure” would be very visibly and undeniably on display? Many of these same dimensions (novelty, risk, and visibility) often intimidate new coders, yet somehow they were core to the paint-and-sip business model.
(Admittedly, the “sipping” part may be a major confounder here, but this isn’t a post on causal inference!)
Of course, this was nothing more than a tongue-in-cheek thought experiment, but it did bring a few observations to the front of my mind.
- The evening was highly structured. It would be miserable (at least, for me) to be given any sort of picture and to simply be told to paint it.1. Instead, the instructor told us and showed us step-by-step which order to tackle the painting in.
- The objective wasn’t too serious. Complete and utter failure was low stakes. No balls would be dropped. No important meetings would have to be postponed. No deadlines would be missed. There was no dire consequence of trying, and possibly failing, to paint a sasquatch.
- The ability to succeed wasn’t correlated with anything important. Hopefully, no one is going to measure their self-worth by sasquatch painting. In contrast, sometimes people unfortunately seem to associate their current technical abilities with a more foundational measure or worth or intelligence. This dramatically increases the cost of “failure” and dissuades exploration.
- The playing field was mostly level. As far as I know, there are no experts in acrylic sasquatch painting.
It did pique my curiosity if these principles could help introduce concepts like GitHub or package development in a friendlier and more engaging way. Over the next few months, life carried on and took me in a variety of directions, including to the Chicago R unconf where I marvelled at the passion and productivity of teams coming together for a two day hackathon. Somewhere in there, a project idea began to form.
Now that you’ve indulged my musings, let me introduce my
Rtistic repo on GitHub.
Rtistic is a package in the sense that you could install it with
devtools::install_github(). However, it is not an R package in the sense that you would be sorely disappointed if you did that.
Rtistic is incomplete, by intent, and always will be. It is a skeleton of an R package and intended to be used as a “hackathon-in-a-box” or an “R package cookbook”. Small groups at a meetup, office, or classroom can come together and collectively build out a package containing palettes and themes for
ggplot2 and RMarkdown. Much like the paint-and-sip, it strives to be highly structured and low stakes.
Rtisticcontinues to evolve. For example, since first writing the below, I have added support for
xaringan, utilized the new GitHub template repository functionality, and further standardized file names. The description below remains accurate in spirit, but the repo
READMEis the best resource for the most up-to-date information for actual use.
Much of the boilerplate code already exists, so partipants are less likely to get caught up on some cryptic error message. Off-the-shelf, the project’s file structure looks similar to what’s shown below (additional files may be added after I post this). Files prefixed with
my- are open to edits by each team.
-- DESCRIPTION -- footer-helpers |__generate-footer-logo.R |__my-footer-template.html |__my-logo.png -- inst |__rmarkdown |__resources |__my-footer.html |__my-styles.css -- LICENSE.md -- man |__figures |__logo.png |__my_html_format.Rd |__my_theme.Rd |__scale_custom.Rd |__test_pal.Rd -- NAMESPACE -- R |__my-gg-palette.R |__my-gg-theme.R |__my-html-format.R |__palette-infrastructure.R -- README.md -- Rtistic.Rproj -- scratchpad |__gg-theme-demo.Rmd |__rmd-theme-demo.Rmd -- vignettes |__my-gg-theme-vignette.Rmd
With this much structure, participants can focus on the fun task of picking colors, fonts, and other theme components. Truly, a team contribution could be as minimal as defining four palettes in a file similar to the provided
test_pal <- c("green", "yellow", "orange", "red") # discrete colors test_pal_op <- c("green", "grey50", "red") # discrete colors mapping to good/neutral/bad test_pal_cont <- c("green", "yellow") # endpoints for a continous scale test_pal_div <- c("green", "yellow", "red") # reference points for diverging scale
Full example file below the fold
#> #' Test palette #> #' #> #' This is a test palette inspired by stop-light colors #> #' #> #' @references https://en.wikipedia.org/wiki/Traffic_light #> #' @name test_pal #> NULL #> #> #' @name test_pal #> #' @export #> # Define disrete palette #> test_pal <- c( #> "#00A850", # green #> "#FEEF01", # yellow #> "#F58222", # orange #> "#E13C29" # red #> ) #> #> #' @name test_pal #> #' @export #> # Define opinionated discrete palette (good, neutral, bad) #> test_pal_op <- c(test_pal, "grey50", test_pal) #> #> #' @name test_pal #> #' @export #> # Define two colors for endpoints of continuous palette #> test_pal_cont <- c(test_pal, test_pal) #> #> #' @name test_pal #> #' @export #> # Define three colors for endpoints of diverging continuous pallete (high, middle, low) #> test_pal_div <- c(test_pal, test_pal, test_pal)
These palettes can then be used in a number of functions (thanks to the
scale_(color/colour/fill)_discrete_rtistic(palette = "test"): Discrete palette with optional
extendparameter to interpolate more values
scale_(color/colour/fill)_opinionated_rtistic(palette = "test"): Discrete palette to map to subjectively coded “good”/“bad”/“neutral” column2
scale_(color/colour/fill)_continuous_rtistic(palette = "test"): Standard continous palette
scale_(color/colour/fill)_diverging_rtistic(palette = "test"): Diverging continuous palette
For example, that contribution leads to the following styles:
To “level up”, participants can also use
roxygen2 syntax to add documentation about their theme and showcase it by editing the
get_rtistic_palettes() function scans the package’s namespace for anything ending in
_pal to help users learn about all the available options3:
Rtistic::get_rtistic_palettes() #>  "test_pal"
ggplot2 and RMarkdown themes is slightly more advanced, but the core design of participants altering templates still holds. Helper functions and instructions are also provided for some of the most esoteric tasks, like encoding a logo image as a URI to be included as a custom footer of a self-contained RMarkdown.
Despite the low barriers to entry, my hope is that there is a lot to learn with
Rtistic. For example, participants might get exposure to:
- Package structure: By filling in the missing pieces of an existing package, teams will navigate through an R package file structure. Whether or not teams have package building aspirations, being able to read package source code is a useful skill.4 It’s also a chance to practice good documentation with commenting and vignette writing.5
- Collaboration on GitHub: I’m convinced no one will ever understand git or GitHub by reading. The easiest way to learn forks, branches, and pull requests is to use them.
Rtisticattempts to make this as easy as possible. Multiple teams should never need to edit the same file, so the likelihood of a big merge conflict problem is low.6
- ggplot2 styling:
ggplot2is intuitive; however, compared to most of the
tidyverse, it is intuitive in the sense of having a rich philosophical basis - not in the sense of “barely needed to read the docs because I can infer it all”. Unfortunately, this difference can make it feel unintuitive to new users. Exposure to
ggplot2theme options pays dividends in getting the most from the package.
- HTML / CSS: R users more typically come from math and stats backgrounds (versus tech), knowledge of front-end web development can be limited. However, users of any of the
*downpackages7 can benefit a lot by having even a cursory understanding of these tools to take advantage of RMarkdown’s customization capabilities.
If this seems like too much at once, the modular nature of the project makes it easy to strip down. If GitHub is out of scope, participants can locally change a small number of files and share them with an organizer for compilation. If
ggplot2 and HTML/CSS are too much to tackle at once, either the plot or RMarkdown theme pieces can be ignored.
A Level Playing Field
For the more complex tasks of
ggplot2 and RMarkdown themes, the
scratchpad/ directory provides additional context. This directory contains two RMarkdown files with working examples of:
- RMarkdown styling with CSS for participants to edit and re-knit. This can help build intuition over how RMarkdown is translated into different HTML tags and how those respond to CSS
- As many ggplot2 theme options as I could possibly fit in one plot with the goal of exposing participants to all of the possible options
The plot, in particular, is hopefully illuminating since the theme is in no way intended to be coherent. Each design choice uses wildly different fonts, colors, and alignments to make it very clear what line of code corresponds to each element:
library(ggplot2) # sample data for plot ---- points <- data.frame( x = rep(1:10,3), y = rep(1:10,3), z = sort(rep(letters[1:2], 15)), w = rep(letters[3:4], 15) ) # ggplot using many theme options ---- ggplot(data = points, mapping = aes(x = x, y = y, col = factor(x))) + geom_point(size = 5) + facet_grid(w ~ z, switch = "y") + theme( plot.background = element_rect(fill = "lightyellow"), plot.title = element_text(size = 30, hjust = 0.25), plot.subtitle = element_text(size = 20, hjust = 0.75, color = "mediumvioletred", family = "serif"), plot.caption = element_text(size = 10, face = "italic", angle = 25), panel.background = element_rect(fill = 'lightblue', colour = 'darkred', size = 4), panel.border = element_rect(fill = NA, color = "green", size = 2), panel.grid.major.x = element_line(color = "purple", linetype = 2), panel.grid.minor.x = element_line(color = "orange", linetype = 3), panel.grid.minor.y = element_blank(), axis.title.x = element_text(face = "bold.italic", color = "blue"), axis.title.y = element_text(family = "mono", face = "bold", size = 20, hjust = 0.25), axis.text = element_text(face = "italic", size = 15), axis.text.x.bottom = element_text(angle = 180), # note that axis.text options from above are inherited strip.background = element_rect(fill = "magenta"), strip.text.y = element_text(color = "white"), strip.placement = "outside", legend.background = element_rect(fill = "orangered4"), # generally will want to match w plot background legend.key = element_rect(fill = "orange"), legend.direction = "horizontal", legend.position = "bottom", legend.justification = "left", legend.title = element_text(family = "serif", color = "white"), legend.text = element_text(family = "mono", face = "italic", color = "limegreen") ) + labs(title = "test title", subtitle = "test subtitle", x = "my x axis", y = "my y axis", caption = "this is a caption", col = "Renamed Legend")
Take it for a Spin!
Complete information and more tactical step-by-step instructions for both organizers and participants can be found on the
Rtistic GitHub repo. Please let me know if you check it out. I welcome any and all feedback!
I will admit that the
opinionatedscale likely is not useful or relevant in many cases. However, since corporate color palettes are one place I can imagine
Rtisticbeing useful, I decided to include it since having a predefined mapping of “good” and “bad” colors (e.g. for profits and losses). I also think it’s a nice discrete parallel to the more typical
divergingscale for continuous-valued variables. ↩︎
This allows discoverability without having to maintain any centralized list of palettes since, for logistical reasons,
Rtisticis designed to be completely modular. ↩︎
For example, I recently started using a package with very little documentation but an excellent test suite. Once I figured this out, I was able to use it a lot more efficiently by learning from the test examples. ↩︎
Another conviction of mine is that these skills should be used for most R projects – not just packages. R’s strong conventions and culture for documentation are one of its hallmarks. ↩︎
Obviously, merge conflicts are an important concept to understand, but as a day-one intro, “how this ideally works” is easier to grasp. ↩︎
Or Shiny, flexdashboard, etc. ↩︎