Merge pull request #166 from dieghernan/colshift

Expand PR #165 to other scales, tests and document

NEWS.md

@@ -5,6 +5,11 @@
 -   Improve handling of factors when several layers have different levels. This
     is done using `terra::combineLevels()` (**terra** \>= `1.8-10`). See
     <https://stackoverflow.com/questions/79340152>.
+-   Now `scales` that uses limits truncate the legend when `limits` parameter is
+    provided (#165 \@Fan-iX). Scales impacted:
+    -   `scale_*_cross_blended_tint_c` and `scale_*_cross_blended_tint_b`.
+    -   `scale_*_hypso_tint_c` and `scale_*_hypso_tint_b`.
+    -   `scale_*_grass_c` and `scale_*_grass_b`.
 
 # tidyterra 0.6.2
 

R/scales_cross_blended.R

@@ -107,20 +107,6 @@
 #'   geom_spatraster(data = volcano2_rast) +
 #'   scale_fill_cross_blended_c(palette = "cold_humid")
 #'
-#' # Use hypsometric  tint version...
-#' ggplot() +
-#'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_cross_blended_tint_c(palette = "cold_humid")
-#'
-#' # ...but not suitable for the range of the raster: adjust
-#' my_lims <- minmax(volcano2_rast) %>% as.integer() + c(-2, 2)
-#'
-#' ggplot() +
-#'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_cross_blended_tint_c(
-#'     palette = "cold_humid",
-#'     limits = my_lims
-#'   )
 #'
 #' # Full map with true tints
 #'
@@ -149,13 +135,12 @@
 #'   geom_spatraster(data = volcano2_rast) +
 #'   scale_fill_cross_blended_b(breaks = seq(70, 200, 25), palette = "arid")
 #'
-#' # With limits and breaks
+#' # With breaks
 #' ggplot() +
 #'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_cross_blended_tint_b(
+#'   scale_fill_cross_blended_b(
 #'     breaks = seq(75, 200, 25),
-#'     palette = "arid",
-#'     limits = my_lims
+#'     palette = "arid"
 #'   )
 #'
 #' # With discrete values
@@ -414,6 +399,11 @@ cross_blended.colors <- function(n, palette = "cold_humid",
 #' almost as an uniform color. This could be adjusted using the
 #' `limits`/`values` parameters.
 #'
+#' When passing `limits` parameter to `scale_*_cross_blended_tint_*` the
+#' colors would be restricted of those specified by this parameter, keeping the
+#' distribution of the tint. You can combine this with `oob` (i.e.
+#' `oob = scales::oob_squish`) to avoid blank pixels in the plot.
+#'
 #' `cross_blended.colors2()` provides a gradient color palette where the
 #' distance between colors is different depending of the type of color.
 #' In contrast, `cross_blended.colors()` provides an uniform gradient across
@@ -503,8 +493,8 @@ scale_fill_cross_blended_tint_c <- function(palette = "cold_humid", ...,
 
   if (is.null(values)) values <- hypsocol$limit
   # Reescale
-  res <- scales::rescale(values)
   if (is.null(limits)) limits <- range(values)
+  res <- scales::rescale(values, from = limits)
 
   ggplot2::scale_fill_gradientn(...,
     colors = hexcol,
@@ -548,8 +538,8 @@ scale_colour_cross_blended_tint_c <- function(palette = "cold_humid", ...,
 
   if (is.null(values)) values <- hypsocol$limit
   # Reescale
-  res <- scales::rescale(values)
   if (is.null(limits)) limits <- range(values)
+  res <- scales::rescale(values, from = limits)
 
   ggplot2::scale_colour_gradientn(...,
     colors = hexcol,
@@ -593,8 +583,8 @@ scale_fill_cross_blended_tint_b <- function(palette = "cold_humid", ...,
 
   if (is.null(values)) values <- hypsocol$limit
   # Reescale
-  res <- scales::rescale(values)
   if (is.null(limits)) limits <- range(values)
+  res <- scales::rescale(values, from = limits)
 
   ggplot2::scale_fill_stepsn(
     ...,
@@ -639,8 +629,8 @@ scale_colour_cross_blended_tint_b <- function(palette = "cold_humid", ...,
 
   if (is.null(values)) values <- hypsocol$limit
   # Reescale
-  res <- scales::rescale(values)
   if (is.null(limits)) limits <- range(values)
+  res <- scales::rescale(values, from = limits)
 
   ggplot2::scale_colour_stepsn(
     ...,

R/scales_grass.R

@@ -82,6 +82,11 @@
 #' `use_grass_range` argument, When `FALSE` the color scales would be mapped
 #' to the range of values of the `color/fill` aesthethics, See **Examples**.
 #'
+#' When passing `limits` parameter the colors would be restricted of those
+#' specified by this parameter, keeping the distribution of the palette. You can
+#' combine this with `oob` (i.e. `oob = scales::oob_squish`) to avoid blank
+#' pixels in the plot.
+#'
 #' @examples
 #' \donttest{
 #' filepath <- system.file("extdata/volcano2.tif", package = "tidyterra")
@@ -239,8 +244,8 @@ scale_fill_grass_c <- function(palette = "viridis", ...,
   } else {
     if (is.null(values)) values <- hypsocol$limit
     # Reescale
-    res <- scales::rescale(values)
     if (is.null(limits)) limits <- range(values)
+    res <- scales::rescale(values, from = limits)
   }
 
   ggplot2::scale_fill_gradientn(...,
@@ -292,8 +297,8 @@ scale_colour_grass_c <- function(palette = "viridis", ...,
   } else {
     if (is.null(values)) values <- hypsocol$limit
     # Reescale
-    res <- scales::rescale(values)
     if (is.null(limits)) limits <- range(values)
+    res <- scales::rescale(values, from = limits)
   }
 
   ggplot2::scale_colour_gradientn(...,
@@ -350,8 +355,8 @@ scale_fill_grass_b <- function(palette = "viridis", ...,
   } else {
     if (is.null(values)) values <- hypsocol$limit
     # Reescale
-    res <- scales::rescale(values)
     if (is.null(limits)) limits <- range(values)
+    res <- scales::rescale(values, from = limits)
   }
 
   ggplot2::scale_fill_stepsn(
@@ -404,8 +409,8 @@ scale_colour_grass_b <- function(palette = "viridis", ...,
   } else {
     if (is.null(values)) values <- hypsocol$limit
     # Reescale
-    res <- scales::rescale(values)
     if (is.null(limits)) limits <- range(values)
+    res <- scales::rescale(values, from = limits)
   }
 
   ggplot2::scale_color_stepsn(

R/scales_hypso.R

@@ -92,20 +92,6 @@
 #'   geom_spatraster(data = volcano2_rast) +
 #'   scale_fill_hypso_c(palette = "colombia_hypso")
 #'
-#' # Use hypsometric  tint version...
-#' ggplot() +
-#'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_hypso_tint_c(palette = "colombia_hypso")
-#'
-#' # ...but not suitable for the range of the raster: adjust
-#' my_lims <- minmax(volcano2_rast) %>% as.integer() + c(-2, 2)
-#'
-#' ggplot() +
-#'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_hypso_tint_c(
-#'     palette = "colombia_hypso",
-#'     limits = my_lims
-#'   )
 #'
 #' # Full map with true tints
 #'
@@ -134,13 +120,12 @@
 #'   geom_spatraster(data = volcano2_rast) +
 #'   scale_fill_hypso_b(breaks = seq(70, 200, 25), palette = "wiki-2.0_hypso")
 #'
-#' # With limits and breaks
+#' # With breaks
 #' ggplot() +
 #'   geom_spatraster(data = volcano2_rast) +
-#'   scale_fill_hypso_tint_b(
+#'   scale_fill_hypso_b(
 #'     breaks = seq(75, 200, 25),
-#'     palette = "wiki-2.0_hypso",
-#'     limits = my_lims
+#'     palette = "wiki-2.0_hypso"
 #'   )
 #'
 #' # With discrete values
@@ -392,6 +377,12 @@ hypso.colors <- function(n, palette = "etopo1_hypso",
 #' almost as an uniform color. This could be adjusted using the
 #' `limits`/`values` parameters.
 #'
+#' When passing `limits` parameter to `scale_*_hypso_tint_*` the colors would
+#' be restricted of those specified by this parameter, keeping the distribution
+#' of the tint. You can combine this with `oob` (i.e.
+#' `oob = scales::oob_squish`) to avoid blank pixels in the plot.
+#'
+#'
 #' `hypso.colors2()` provides a gradient color palette where the distance
 #' between colors is different depending of the type of color. In contrast,
 #' `hypso.colors()` provides an uniform gradient across colors. See

tests/testthat/test-scales_col_cross_blended.R

@@ -211,7 +211,7 @@ test_that("Continous scale tint", {
   # Modify limits
   p3 <- p + scale_color_cross_blended_tint_c(limits = c(20, 26))
   mod_lims <- ggplot2::layer_data(p3)$colour
-  expect_true(!any(mod_lims %in% mod))
+  expect_identical(mod_lims, mod)
   expect_true(!any(mod_lims %in% init))
 
   # Modify also with values
@@ -222,7 +222,7 @@ test_that("Continous scale tint", {
   mod_values <- ggplot2::layer_data(p4)$colour
   expect_true(!any(mod_values %in% mod_lims))
   expect_true(!any(mod_values %in% mod))
-  expect_true(!any(mod_values %in% init))
+  expect_true(any(mod_values %in% init))
 })
 
 test_that("Breaking scale", {
@@ -366,3 +366,36 @@ test_that("Breaking scale tint", {
   expect_true(!any(mod_values %in% mod))
   expect_true(!any(mod_values %in% init))
 })
+
+
+test_that("PR 165", {
+  suppressWarnings(library(ggplot2))
+  suppressWarnings(library(terra))
+
+  #  Import also vector
+  f <- system.file("extdata/asia.tif", package = "tidyterra")
+  r <- rast(f)
+
+
+  p1 <- ggplot() +
+    geom_spatraster(data = r) +
+    scale_fill_cross_blended_tint_c()
+
+  wlims1 <- ggplot() +
+    geom_spatraster(data = r) +
+    scale_fill_cross_blended_tint_c(limits = c(500, 4000))
+
+  wlims2 <- ggplot() +
+    geom_spatraster(data = r) +
+    scale_fill_cross_blended_tint_c(
+      limits = c(0, 600),
+      oob = scales::squish
+    )
+
+
+
+  # Scales
+  vdiffr::expect_doppelganger("pr165_01: nolims", p1)
+  vdiffr::expect_doppelganger("pr165_02: lims1", wlims1)
+  vdiffr::expect_doppelganger("pr165_03: lims1", wlims2)
+})

tests/testthat/test-scales_col_hypso.R

@@ -201,7 +201,7 @@ test_that("Continous scale tint", {
   # Modify limits
   p3 <- p + scale_colour_hypso_tint_c(limits = c(20, 26))
   mod_lims <- ggplot2::layer_data(p3)$colour
-  expect_true(!any(mod_lims %in% mod))
+  expect_identical(mod_lims, mod)
   expect_true(!any(mod_lims %in% init))
 
   # Modify also with values
@@ -212,7 +212,7 @@ test_that("Continous scale tint", {
   mod_values <- ggplot2::layer_data(p4)$colour
   expect_true(!any(mod_values %in% mod_lims))
   expect_true(!any(mod_values %in% mod))
-  expect_true(!any(mod_values %in% init))
+  expect_true(any(mod_values %in% init))
 })
 
 test_that("Breaking scale", {