Add examples

NAMESPACE

@@ -11,6 +11,9 @@ export(info)
 export(palette_color_continuous)
 export(palette_color_discrete)
 export(palette_color_picker)
+export(palette_colour_continuous)
+export(palette_colour_discrete)
+export(palette_colour_picker)
 export(palette_line)
 export(palette_shape)
 export(palette_size_range)

R/palettes.R

@@ -52,6 +52,10 @@ palette_color_picker <- function(scheme, domain = NULL, midpoint = NULL,
   fun
 }
 
+#' @export
+#' @rdname palette_color_picker
+palette_colour_picker <- palette_color_picker
+
 #' Color Mapping (continuous)
 #'
 #' Maps continuous values to an interpolated colors gradient.
@@ -66,7 +70,7 @@ palette_color_picker <- function(scheme, domain = NULL, midpoint = NULL,
 #'  A palette [`function`] that when called with a single argument
 #'  (a [`numeric`] vector of continuous values) returns a [`character`] vector
 #'  of colors.
-#' @note Designed after scales
+#' @example inst/examples/ex-palette-continuous.R
 #' @family palettes
 #' @export
 palette_color_continuous <- function(colors = NULL, domain = NULL,
@@ -105,6 +109,10 @@ palette_color_continuous <- function(colors = NULL, domain = NULL,
   }
 }
 
+#' @export
+#' @rdname palette_color_continuous
+palette_colour_continuous <- palette_color_continuous
+
 #' Color Mapping (discrete)
 #'
 #' Maps categorical values to colors.
@@ -118,6 +126,7 @@ palette_color_continuous <- function(colors = NULL, domain = NULL,
 #' @return
 #'  A palette [`function`] that when called with a single argument
 #'  (a vector of categorical values) returns a [`character`] vector of colors.
+#' @example inst/examples/ex-palette-discrete.R
 #' @family palettes
 #' @export
 palette_color_discrete <- function(colors = NULL, domain = NULL,
@@ -156,6 +165,10 @@ palette_color_discrete <- function(colors = NULL, domain = NULL,
   }
 }
 
+#' @export
+#' @rdname palette_color_discrete
+palette_colour_discrete <- palette_color_discrete
+
 ## Symbol ----------------------------------------------------------------------
 #' Symbol Mapping
 #'

inst/examples/ex-compare.R

@@ -1,21 +1,19 @@
 # Trichromat
 pal <- colour("bright")
-
-(deltaE <- compare(pal(5)))
-summary(deltaE)
+compare(pal(5))
 
 # Deuteranopia
-deu <- convert(pal, mode = "deuteranopia")
+deu <- change(pal, mode = "deuteranopia")
 compare(deu(5))
 
 # Protanopia
-pro <- convert(pal, mode = "protanopia")
+pro <- change(pal, mode = "protanopia")
 compare(pro(5))
 
 # Tritanopia
-tri <- convert(pal, mode = "tritanopia")
+tri <- change(pal, mode = "tritanopia")
 compare(tri(5))
 
 # Achromatopsia
-ach <- convert(pal, mode = "achromatopsia")
+ach <- change(pal, mode = "achromatopsia")
 compare(ach(5))

inst/examples/ex-palette-continuous.R

@@ -0,0 +1,14 @@
+## Visualize a simple DEM model
+## Distribution of elevation values
+elevation <- hist(volcano)
+
+## Where are breaks?
+elevation$breaks
+
+## Build palette functions
+BuRd <- color("BuRd")
+ramp_BuRd <- palette_color_continuous(colors = BuRd(10))
+
+## Plot image
+image(volcano, col = ramp_BuRd(elevation$breaks))
+legend("topright", legend = elevation$breaks, fill = ramp_BuRd(elevation$breaks))

inst/examples/ex-palette-discrete.R

@@ -0,0 +1,16 @@
+## Build palette functions
+bright <- c(versicolor = "#4477AA", virginica = "#EE6677", setosa = "#228833")
+ramp_bright <- palette_color_discrete(colors = bright)
+
+## Plot
+plot(
+  x = iris$Petal.Length,
+  y = iris$Sepal.Length,
+  pch = 16,
+  col = ramp_bright(iris$Species),
+  xlab = "Petal length",
+  ylab = "Sepal length",
+  panel.first = grid(),
+  las = 1
+)
+legend("topleft", legend = names(bright), col = bright, pch = 16)