Fixes #3 and switched to pkgdown from staticdoc

Author: Bhaskar Karambelkar

DESCRIPTION

@@ -1,10 +1,10 @@
 Package: colormap
 Type: Package
 Title: Color Palettes using Colormaps Node Module
-Version: 0.1.3
+Version: 0.1.4
 Authors@R: person("Bhaskar", "Karambelkar", email = "[email protected]",
     role = c("aut", "cre"))
-Description: This is an R package that allows you to generate colors from color palettes defined in Node.js's colormap (https://github.com/bpostlethwaite/colormap) module. In total it provides 44 distinct palettes made from sequential and/or diverging colors. In addition to the pre defined palettes you can also specify your own set of colors. There are also scale functions that can be used with ggplot2.
+Description: Allows to generate colors from palettes defined in the colormap module of 'Node.js'. (see <https://github.com/bpostlethwaite/colormap> for more information). In total it provides 44 distinct palettes made from sequential and/or diverging colors. In addition to the pre defined palettes you can also specify your own set of colors. There are also scale functions that can be used with 'ggplot2'.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true

NEWS.md

@@ -1,3 +1,7 @@
+# colormap 0.1.4
+
+* Made viridis the default theme.
+
 # colormap 0.1.3
 
 * Fixed all R CMD Check warnings/notes.

R/colormap.R

@@ -89,15 +89,15 @@ colormaps <- list(
 #'
 #' @return Colors either in vector, matrix, list format depending on format.
 #' @examples
-#' colormap() # Defaults to 72 colors from the 'jet' palette.
+#' colormap() # Defaults to 72 colors from the 'viridis' palette.
 #' colormap(colormap=colormaps$temperature, nshades=20) # Diff Palette
 #' colormap(colormap=c('#000000','#FF0000'), nshades=20) # Colormap as vector of colors
 #' # list of list. Maximum flexibility
 #' colormap(colormap=list(list(index=0,rgb=c(0,0,0)),list(index=1,rgb=c(255,255,255))), nshades=10)
 #' colormap(format='rgb',nshades=10) # As rgb
 #' colormap(format='rgb',nshades=10,alpha=0.5) # Constant alpha
 #' colormap(format='rgbaString',nshades=10) # As rgba string
-colormap <- function(colormap=colormaps$jet, nshades=72,
+colormap <- function(colormap=colormaps$viridis, nshades=72,
                      format='hex', alpha=1, reverse=FALSE) {
 
   # validate inputs
@@ -107,10 +107,10 @@ colormap <- function(colormap=colormaps$jet, nshades=72,
            colormap))
     } else if(length(colormap)>1 && !(all(grepl('^#[0-9a-f]{6}$',colormap,
                                                 ignore.case = T)))) {
-    stop("colormap parameter should be a single string from the colormap::colormaps list or a vector of strings in HEX color format\n e.g. colormap='jet' or colormap=c('#FCFDA1','#FF0033')")
+    stop("colormap parameter should be a single string from the colormap::colormaps list or a vector of strings in HEX color format\n e.g. colormap='viridis' or colormap=c('#FCFDA1','#FF0033')")
     }
   } else if(!inherits(colormap,'list')) {
-    stop("colormap parameter should be a single string from the colormap::colormaps list or a vector of strings in HEX color format\n e.g. colormap='jet' or colormap=c('#FCFDA1','#FF0033') or a list of lists e.g. colormap=list(list(index=0,rgb=c(0,0,0)),list(index=1,rgb=c(255,255,255)))")
+    stop("colormap parameter should be a single string from the colormap::colormaps list or a vector of strings in HEX color format\n e.g. colormap='viridis' or colormap=c('#FCFDA1','#FF0033') or a list of lists e.g. colormap=list(list(index=0,rgb=c(0,0,0)),list(index=1,rgb=c(255,255,255)))")
   }
 
   if(!(is.numeric(alpha) && alpha >=0 && alpha <= 1)) {

R/scales.R

@@ -14,7 +14,7 @@
 #' @return A function that can generate colors from a specified colormap.
 #'
 #' @export
-colormap_pal <- function(alpha = 1, colormap = colormaps$jet, reverse=FALSE) {
+colormap_pal <- function(alpha = 1, colormap = colormaps$viridis, reverse=FALSE) {
   function(n) {
     colormap(colormap=colormap, alpha = alpha,
              format='hex', reverse=reverse,
@@ -28,7 +28,7 @@ colormap_pal <- function(alpha = 1, colormap = colormaps$jet, reverse=FALSE) {
 #' @aliases scale_colour_colormap
 #'
 #' @export
-scale_color_colormap <- function(..., alpha = 1, colormap = colormaps$jet,
+scale_color_colormap <- function(..., alpha = 1, colormap = colormaps$viridis,
                                 discrete = FALSE, reverse = FALSE) {
 
   if (discrete) {
@@ -67,7 +67,7 @@ scale_color_colormap <- function(..., alpha = 1, colormap = colormaps$jet,
 #' @rdname scale_colormap
 #'
 #' @export
-scale_fill_colormap <- function(..., alpha = 1, colormap = colormaps$jet,
+scale_fill_colormap <- function(..., alpha = 1, colormap = colormaps$viridis,
                                 discrete = FALSE, reverse = FALSE) {
 
   if (discrete) {

README-eg1-1.png

@@ -59,7 +59,7 @@ The main function is `colormap` which takes 5 optional arguments
 ```{r eg1}
 library(colormap)
 
-# Defaults to 72 colors from the 'jet' palette.
+# Defaults to 72 colors from the 'viridis' palette.
 scales::show_col(colormap(), labels = F)
 
 # Specify a different palette from a list of pre-defined palette.

README.Rmd

@@ -52,7 +52,7 @@ Example
 ``` r
 library(colormap)
 
-# Defaults to 72 colors from the 'jet' palette.
+# Defaults to 72 colors from the 'viridis' palette.
 scales::show_col(colormap(), labels = F)
 ```
 
@@ -97,17 +97,17 @@ You can also get the colors in a 'rgb' matrix and a rgba string vector format
 ``` r
 colormap(format='rgb',nshades=5) # As rgb
 #>      [,1] [,2] [,3] [,4]
-#> [1,]    0    0  131    1
-#> [2,]    2  156  212    1
-#> [3,]  128  255  130    1
-#> [4,]  253  130    0    1
-#> [5,]  128    0    0    1
+#> [1,]   68    1   84    1
+#> [2,]   59   81  139    1
+#> [3,]   33  144  141    1
+#> [4,]   92  200   99    1
+#> [5,]  253  231   37    1
 
 colormap(format='rgbaString',nshades=10) # As rgba string
-#>  [1] "rgba(0,0,131,1)"    "rgba(0,54,166,1)"   "rgba(2,134,202,1)" 
-#>  [4] "rgba(4,224,242,1)"  "rgba(72,255,186,1)" "rgba(188,255,69,1)"
-#>  [7] "rgba(254,215,0,1)"  "rgba(252,97,0,1)"   "rgba(238,0,0,1)"   
-#> [10] "rgba(128,0,0,1)"
+#>  [1] "rgba(68,1,84,1)"    "rgba(71,39,117,1)"  "rgba(62,72,135,1)" 
+#>  [4] "rgba(49,102,141,1)" "rgba(38,130,141,1)" "rgba(36,157,136,1)"
+#>  [7] "rgba(55,181,120,1)" "rgba(109,204,88,1)" "rgba(176,221,49,1)"
+#> [10] "rgba(253,231,37,1)"
 ```
 
 You also get `scale_fill_colormap` and `scale_color_colormap` functions for using these palettes in ggplot2 plots. Check `?colormap::scale_fill_colormap` for details.
@@ -211,8 +211,6 @@ Here is a plot showing all 44 pre-defined color palettes and the colors they gen
 
 ``` r
 ensureCranPkg('purrr')
-#> Installing package into '/opt/user/code/personal/github/colormap/packrat/lib/x86_64-apple-darwin15.6.0/3.3.1'
-#> (as 'lib' is unspecified)
 par(mfrow=c(44,1))
 par(mar=rep(0.25,4))
 purrr::walk(colormaps, function(x) {