Show all nmfs palettes (#67)

* Update display_nmfs_palette so that it's based in ggplot2 instead of graphics::image() and is easier to use with a function that will display all palettes at once

* Add function that shows all palettes

* Add @return to documentation for all_nmfs_palettes() and display_nmfs_palette(); update title of latter function; update documentation

* Update tests

Author: sbreitbart-NOAA

DESCRIPTION

@@ -17,6 +17,7 @@ BugReports: https://github.com/nmfs-ost/nmfspalette/issues
 Imports: 
     cli,
     ggplot2,
+    pals,
     rlang
 Suggests: 
     dichromat,

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(all_nmfs_palettes)
 export(display_nmfs_palette)
 export(nmfs_cols)
 export(nmfs_palette)

R/nmfs_cols.R

@@ -350,27 +350,62 @@ nmfs_palette <- function(palette = "oceans", reverse = FALSE, ...) {
   grDevices::colorRampPalette(pal, ...)
 }
 
-#' Return function to interpolate a nmfs color palette
+#' Return interpolated nmfs color palette
 #'
 #' @param name Character name of palette in nmfs_palettes.
 #' @param n Number of colors in palette.
-#' @param ... Additional arguments to pass to [graphics::image()].
 #' @examples
 #' display_nmfs_palette("oceans", 10)
+#' @return A list object showing a specific nmfs color palette in the plot window.
 #' @export
-display_nmfs_palette <- function(name, n, ...) {
+display_nmfs_palette <- function(name, n) {
   pal <- nmfs_palette(name)(n)
-  graphics::image(
-    1:n,
-    1,
-    as.matrix(1:n),
-    col = pal,
-    xlab = paste(name),
-    ylab = "",
-    xaxt = "n",
-    yaxt = "n",
-    bty = "n",
-    ...
+  df <- data.frame(
+    x = 1,
+    y = seq_along(pal),
+    color = pal
   )
-  graphics::box()
+
+  ggplot2::ggplot(df,
+                  ggplot2::aes(x = y,
+                               y = x,
+                               fill = color)) +
+    ggplot2::geom_tile() +
+    ggplot2::scale_fill_identity() +
+    ggplot2::coord_fixed(ratio = 1) +
+    ggplot2::theme_void() +
+    ggplot2::labs(title = name) +
+    ggplot2::theme(plot.title = ggplot2::element_text(hjust = 0.5,
+                                    vjust = 1,
+                                    size = 12,
+                                    face = "bold"),
+                  plot.margin = ggplot2::unit(c(1,1,1,1), "cm"))
+ # plot.margin = ggplot2::unit(c(2,2,2,2), "cm"))
+
+}
+
+#' Return function that shows all nmfs color palettes
+#'
+#' @examples
+#' all_nmfs_palettes()
+#'
+#' @return A null object showing all nmfs color palettes in the plot window.
+#' @export
+all_nmfs_palettes <- function() {
+
+  # default setting
+  old_par <- par(mar = c(0,6,0,0))
+
+  # reset par to original setting
+  on.exit(par(old_par))
+
+    do.call(
+      pals::pal.bands,
+      c(nmfs_palettes,
+        list(labels = names(nmfs_palettes),
+             gap = 0.1,
+             show.names = FALSE)
+        )
+    )
+
 }

README.Rmd

@@ -63,7 +63,15 @@ nmfs_palette("oceans")(10)
 
 ## Palettes
 
-To see the palettes, use the `display_nmfs_palette()` function.
+Use the `all_nmfs_palettes()` function to see all available palettes.
+
+```{r}
+#| label: all_pals
+#| fig-height: 4
+all_nmfs_palettes()
+```
+
+Use the `display_nmfs_palette()` function to see a specific palette.
 
 ### Main NOAA Fisheries palettes
 

man/all_nmfs_palettes.Rd

@@ -14,18 +14,14 @@
        [1] "#901200" "#9D1200" "#AA1200" "#B71300" "#C31802" "#CF1D04" "#DB2207"
        [8] "#E63A21" "#F3533C" "#FF6C57"
 
-# nmfs_palette() fails
-
-    Code
-      nmfs_palette("foo")
-    Condition
-      Error in `interpolate()`:
-      ! need at least two non-NA values to interpolate
-
 # display_nmfs_palette() works
 
     Code
-      urchin_palette
+      urchin_palette$data
     Output
-      NULL
+        x y   color
+      1 1 1 #A8B8FF
+      2 1 2 #737BE6
+      3 1 3 #5761C0
+      4 1 4 #3B469A
 

man/display_nmfs_palette.Rd

@@ -14,22 +14,20 @@ test_that("nmfs_palette() works", {
   )
 })
 
+# Check that fake palette names create an error
 test_that("nmfs_palette() fails", {
-  # Check that fake palette names create an error
-  expect_snapshot(
-    error = TRUE,
-    nmfs_palette("foo")
-  )
+  expect_error(nmfs_palette("foo"))
+
+  expect_error(nmfs_palette("foo"),
+                 "need at least two non-NA values to interpolate")
 })
 
 test_that("display_nmfs_palette() works", {
   # Check that display_nmfs_palette returns a function
   urchin_palette <- display_nmfs_palette("urchin", 4)
 
-  expect_type(urchin_palette, "NULL")
+  expect_type(urchin_palette, "list")
 
   # Check that display_nmfs_palette() returns a snapshot
-  expect_snapshot(
-    urchin_palette
-  )
+  expect_snapshot(urchin_palette$data)
 })