More doc, more examples

R/RColorLisa.R

@@ -1,7 +1,7 @@
 #' Color Palettes from the Masters
 #'
 #' This function allows you to easily load color palettes from great painters into R.
-#' @param n Number of colors to return.
+#' @param n Number of colors to return. Defaults to 5.
 #' @param name Name of painting
 #' @keywords colors
 #' @export

README.md

@@ -1,12 +1,41 @@
 # RColorLisa
 Easily load color palettes from great painters into R. Based on the wonderful work of Ryan McGuire who created the beautiful site [Color Lisa](http://colorlisa.com).
 
+## Installation
+```R
+devtools::install_github("vikjam/RColorLisa")
+```
+
 ## Usage
 
-### Create a sequential palette for usage and show colors
+### Examples
 ```R
+# Create a sequential palette for usage and show colors
 pretty.palette <- color.lisa.pal(5, "The Dream by Pablo Picasso")
 image(1:5, 1, as.matrix(1:5), col = pretty.palette, xlab = "The Dream by Pablo Picasso",
       ylab = "", xaxt = "n", yaxt = "n", bty = "n")
 ```
+![the-dream](figures/the-dream.png)
+
+```R
+# ggplot2 example
+library(ggplot2)
+df <- data.frame(x = rep(c(2, 5, 7, 9, 12), 2),
+                 y = rep(c(1, 2), each = 5),
+                 z = factor(rep(1:5, each = 2))
+)
+escher.pal <- color.lisa.pal(5, "Gravity by M.C. Escher")
+ggplot(df, aes(x, y)) + geom_tile(aes(fill = z)) +
+                        scale_fill_manual(values = escher.pal)
+```
+![escher-tile](figures/escher-tile.png)
 
+```R
+# Slightly more practical ggplot2 example
+library(ggplot2)
+ernst.pal <- color.lisa.pal(5, "Woman, Old Man, and Flower by Max Ernst")
+ggplot(iris, aes(Sepal.Length, Sepal.Width, color = Species)) + 
+       geom_point(size = 3) + 
+       scale_color_manual(values = ernst.pal)
+```
+![iris-ernst](figures/iris-ernst.png)

grab-colors.rb

@@ -1,5 +1,5 @@
+# Hacky script to extract the colors
 require 'nokogiri'
-require 'pp'
 
 color_lisa_html = File.open("color-lisa.html") { | f | Nokogiri::HTML(f) }