From cfd2266fae34780acc8447b7b77eaf5fc5030bac Mon Sep 17 00:00:00 2001 From: Derek Friend Date: Sat, 23 Nov 2024 16:44:58 -0600 Subject: [PATCH] update formatting/documentation of 'changeColors()' --- R/changeColors.R | 73 +++++++++++++++++++++++++++------------------ man/changeColors.Rd | 36 +++++++++++++--------- 2 files changed, 66 insertions(+), 43 deletions(-) diff --git a/R/changeColors.R b/R/changeColors.R index ed3e17a..08bdfcf 100644 --- a/R/changeColors.R +++ b/R/changeColors.R @@ -1,56 +1,71 @@ -# pulled from the gplots package: https://cran.r-project.org/web/packages/gplots/index.html -col2hex <- function(cname) -{ - colMat <- col2rgb(cname) - rgb( - red=colMat[1,]/255, - green=colMat[2,]/255, - blue=colMat[3,]/255 +# pulled from the gplots package: +# https://cran.r-project.org/web/packages/gplots/index.html +col2hex <- function(cname) { + colMat <- grDevices::col2rgb(cname) + grDevices::rgb( + red = colMat[1, ] / 255, + green = colMat[2, ] / 255, + blue = colMat[3, ] / 255 ) } -changeColorsDependencies <- function(){ +changeColorsDependencies <- function() { list( htmltools::htmlDependency( - "changeColors", + "gradientmaps", "0.0.1", - system.file("htmlwidgets/lib/gradientmaps", package = "leafem"), + src = system.file("htmlwidgets/lib/gradientmaps", package = "leafem"), + package = "leafem", script = "gradientmaps.js" + ), + htmltools::htmlDependency( + "gradientmaps_r_binding", + utils::packageVersion("leafem"), + src = system.file("htmlwidgets/lib/gradientmaps", package = "leafem"), + package = "leafem", + script = "changeColors.js" ) ) } - #' Change the color palette of a map layer -#' @description Given a class name that corresponds to a map layer or layers, uses the -#' 'gradientmap' JavaScript library to change the color scheme on the fly +#' @description Given a class name that corresponds to a map layer or layers, +#' uses the 'gradientmap' JavaScript library to change the color scheme on the +#' fly #' @param map a mapview or leaflet object. -#' @param className character; the class name to apply the color-change to. The layer(s) -#' must have had this class name assigned to it; see examples -#' @param colors character vector; the colors that form the new color palette. Colors -#' can be either named colors in R (like "red" or "blue") or hexadecimal colors +#' @param className character; the class name to apply the color-change to. The +#' layer(s) must have had this class name assigned to it; see examples +#' @param colors character vector; the colors that form the new color palette. +#' Colors can be either named colors in R (like "red" or "blue") or +#' hexadecimal colors #' @examples #' if (interactive()) { -#' library(leafem) #' library(leaflet) #' -#' leaflet() %>% -#' addTiles() %>% -#' addWMSTiles("https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2016_Bare_Ground_Shrubland_Fractional_Component/ows?SERVICE=WMS&", -#' layers = "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component", -#' options = WMSTileOptions(className = "bare_ground", transparent = TRUE, format = "image/png")) %>% +#' leaflet() |> +#' addTiles() |> +#' addWMSTiles( +#' paste0( +#' "https://www.mrlc.gov/geoserver/mrlc_display/", +#' "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component/", +#' "ows?SERVICE=WMS&" +#' ), +#' layers = "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component", +#' options = WMSTileOptions(className = "bare_ground", +#' transparent = TRUE, +#' format = "image/png")) |> #' changeColors("bare_ground", terrain.colors(20)) #' -#' leaflet() %>% -#' addTiles(options = tileOptions(className = "base")) %>% +#' leaflet() |> +#' addTiles(options = tileOptions(className = "base")) |> #' changeColors("base", colorRampPalette(c("red", "white"))(50)) #' } #' @export -changeColors <- function(map, className, colors){ +changeColors <- function(map, className, colors) { - if (inherits(map, "mapview")) map = mapview2leaflet(map) + if (inherits(map, "mapview")) map <- mapview2leaflet(map) - map$dependencies = c( + map$dependencies <- c( map$dependencies, changeColorsDependencies() ) diff --git a/man/changeColors.Rd b/man/changeColors.Rd index c4d69d7..9f497fe 100644 --- a/man/changeColors.Rd +++ b/man/changeColors.Rd @@ -9,30 +9,38 @@ changeColors(map, className, colors) \arguments{ \item{map}{a mapview or leaflet object.} -\item{className}{character; the class name to apply the color-change to. The layer(s) -must have had this class name assigned to it; see examples} +\item{className}{character; the class name to apply the color-change to. The +layer(s) must have had this class name assigned to it; see examples} -\item{colors}{character vector; the colors that form the new color palette. Colors -can be either named colors in R (like "red" or "blue") or hexadecimal colors} +\item{colors}{character vector; the colors that form the new color palette. +Colors can be either named colors in R (like "red" or "blue") or +hexadecimal colors} } \description{ -Given a class name that corresponds to a map layer or layers, uses the -'gradientmap' JavaScript library to change the color scheme on the fly +Given a class name that corresponds to a map layer or layers, + uses the 'gradientmap' JavaScript library to change the color scheme on the + fly } \examples{ if (interactive()) { - library(leafem) library(leaflet) - leaflet() \%>\% - addTiles() \%>\% - addWMSTiles("https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2016_Bare_Ground_Shrubland_Fractional_Component/ows?SERVICE=WMS&", - layers = "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component", - options = WMSTileOptions(className = "bare_ground", transparent = TRUE, format = "image/png")) \%>\% + leaflet() |> + addTiles() |> + addWMSTiles( + paste0( + "https://www.mrlc.gov/geoserver/mrlc_display/", + "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component/", + "ows?SERVICE=WMS&" + ), + layers = "NLCD_2016_Bare_Ground_Shrubland_Fractional_Component", + options = WMSTileOptions(className = "bare_ground", + transparent = TRUE, + format = "image/png")) |> changeColors("bare_ground", terrain.colors(20)) - leaflet() \%>\% - addTiles(options = tileOptions(className = "base")) \%>\% + leaflet() |> + addTiles(options = tileOptions(className = "base")) |> changeColors("base", colorRampPalette(c("red", "white"))(50)) } }