Authors
Joe Thorley. Contributor. 
+
Copyright (c) 2018 Poisson Consulting Ltd.
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the âSoftwareâ), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED âAS ISâ, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Joe Thorley. Contributor.
+
tinter provides a simple way to generate monochromatic palettes. Easily define:
steps).crop = 1 eliminates black and white).crop = 1 eliminates black and white).adjust).
tinter(hex)
-#> [1] "#D6DEEE" "#ADBDDD" "#849DCD" "#5B7CBC" "#335CAC" "#284989" "#1E3767"
-#> [8] "#142444" "#0A1222"
library(tinter) +hex <- "#335CAC"
tinter(hex) +#> [1] "#D6DEEE" "#ADBDDD" "#849DCD" "#5B7CBC" "#335CAC" "#284989" "#1E3767" +#> [8] "#142444" "#0A1222"
tinter(hex, direction = "tints")
tinter(hex, steps = 10)
tinter(hex, steps = 10, crop = 7)
tinter(hex, steps = 10, crop = 7, adjust = 0.4)
library(ggplot2)
-library(sf)
-
-nc <- st_read(system.file(package = "sf", "shape/nc.shp"))
-
-ggplot(data = nc) +
- geom_sf(aes(fill = AREA), colour = "white", lwd = 0.05) +
- # colours from tinter
- scale_fill_gradientn(colours = tinter(hex)) +
- theme_void() +
- coord_sf(datum = NA)
library(ggplot2) +library(sf) + +nc <- st_read(system.file(package = "sf", "shape/nc.shp")) + +ggplot(data = nc) + + geom_sf(aes(fill = AREA), colour = "white", lwd = 0.05) + + # colours from tinter + scale_fill_gradientn(colours = tinter(hex)) + + theme_void() + + coord_sf(datum = NA)
tinter just simplifies a task usually done with grDevices. It’s default is to remove black and white from the palette.
tinter("blue")
-#> [1] "#CCCCFF" "#9999FF" "#6666FF" "#3333FF" "#0000FF" "#0000CC" "#000099"
-#> [8] "#000065" "#000032"
-
-### ------ is identical to
-
-grDevices::colorRampPalette(colors = c("white", "blue", "black"))(11)[-(c(1, 11))]
-#> [1] "#CCCCFF" "#9999FF" "#6565FF" "#3232FF" "#0000FF" "#0000CB" "#000098"
-#> [8] "#000065" "#000032"tinter("blue", direction = "shades")
-#> [1] "#0000FF" "#0000CC" "#000099" "#000065" "#000032"
-
-### --- is identical to
-
-grDevices::colorRampPalette(colors = c("blue", "black"))(6)[-6]
-#> [1] "#0000FF" "#0000CC" "#000099" "#000065" "#000032"tinter("blue", crop = 2)
-#> [1] "#9999FF" "#6666FF" "#3333FF" "#0000FF" "#0000CC" "#000099" "#000065"
-
-### --- is identical to
-
-grDevices::colorRampPalette(colors = c("white", "blue", "black"))(11)[-(c(1:2, 10:11))]
-#> [1] "#9999FF" "#6565FF" "#3232FF" "#0000FF" "#0000CB" "#000098" "#000065"tinter just simplifies a task usually done with grDevices. Itâs default is to remove black and white from the palette.
tinter("blue") +#> [1] "#CCCCFF" "#9999FF" "#6666FF" "#3333FF" "#0000FF" "#0000CC" "#000099" +#> [8] "#000065" "#000032" + +### ------ is identical to + +grDevices::colorRampPalette(colors = c("white", "blue", "black"))(11)[-(c(1, 11))] +#> [1] "#CCCCFF" "#9999FF" "#6565FF" "#3232FF" "#0000FF" "#0000CB" "#000098" +#> [8] "#000065" "#000032"
tinter("blue", direction = "shades") +#> [1] "#0000FF" "#0000CC" "#000099" "#000065" "#000032" + +### --- is identical to + +grDevices::colorRampPalette(colors = c("blue", "black"))(6)[-6] +#> [1] "#0000FF" "#0000CC" "#000099" "#000065" "#000032"
tinter("blue", crop = 2) +#> [1] "#9999FF" "#6666FF" "#3333FF" "#0000FF" "#0000CC" "#000099" "#000065" + +### --- is identical to + +grDevices::colorRampPalette(colors = c("white", "blue", "black"))(11)[-(c(1:2, 10:11))] +#> [1] "#9999FF" "#6565FF" "#3232FF" "#0000FF" "#0000CB" "#000098" "#000065"
To install from CRAN
-install.packages("tinter")To install the latest development version from GitHub
-install.packages("devtools")
-devtools::install_github("poissonconsulting/err")
-devtools::install_github("poissonconsulting/checkr")
-devtools::install_github("poissonconsulting/tinter")To install the latest development version from the Poisson drat repository
-install.packages("drat")
-drat::addRepo("poissonconsulting")
-install.packages("tinter")To install the latest release from CRAN
+install.packages("tinter")
To install the developmental version from GitHub
+# install.packages("remotes") +remotes::install_github("poissonconsulting/tinter")
To install the latest developmental release from the Poisson drat repository
+# install.packages("drat") +drat::addRepo("poissonconsulting") +install.packages("tinter")
Checks that x is a string (non-missing character vector of length 1) +that specifies a color.
+chk_color
+checks if a color string.
chk_colour
+checks if a color string.
chk_color(x, x_name = NULL) + +chk_colour(x, x_name = NULL)+ +
| x | +The object to check. |
+
|---|---|
| x_name | +A string of the name of object x or NULL. |
+
NULL, invisibly. Called for the side effect of throwing an error
+if the condition is not met.
chk_color: Check Color String Object
chk_colour: Check Color String Object
+#> Error in FALSE : `"glue"` must be a valid color.#> Error in FALSE : `"glue"` must be a valid color.
Darken colour.
-darken(x, amount)- +
A number from 0 to 1. |
A vector of modified colours.
-#> [1] "#A5A5CE" "#7B7BCE" "#5252CE" "#2929CE" "#0000CE" "#0000A5" "#00007B" #> [8] "#000051" "#000028"
Lighten colour.
-lighten(x, amount)- +
A number from 0 to 1. |
A vector of modified colours.
-#> [1] "#F5F5FF" "#EBEBFF" "#E1E1FF" "#D8D8FF" "#CECEFF" "#CECEF5" "#CECEEB" #> [8] "#CECEE1" "#CECED8"
Generate shades, tints or both from a colour.
-tinter(x, steps = 5, crop = 1, direction = "both", adjust = 0)- +
A number between -1 and 1. Values between 0 and -1 increasingly darken colour; values between 0 and 1 increasingly lighten colour. |
A vector of colours.
-- + + + diff --git a/docs/reference/vld_color.html b/docs/reference/vld_color.html new file mode 100644 index 0000000..278fe8a --- /dev/null +++ b/docs/reference/vld_color.html @@ -0,0 +1,193 @@ + + + + + + + + +tinter("blue")#> [1] "#CCCCFF" "#9999FF" "#6666FF" "#3333FF" "#0000FF" "#0000CC" "#000099" @@ -153,32 +165,30 @@Examp #> [8] "#FA6A5C" "#E15F52" "#C85449" "#AF4A40" "#953F37" "#7D352E" "#632A24" #> [15] "#4A1F1B"
tinter("#fa6a5c", direction = "tints")#> [1] "#FEE1DE" "#FDC3BD" "#FBA59D" "#FB877C" "#FA6A5C"
Validates whether x is a string (non-missing character vector of length 1) +that specifies a color.
+vld_color(x) + +vld_colour(x)+ +
| x | +The object to check. |
+
|---|
A flag indicating whether the object was validated.
+vld_color: Validate Color String
vld_colour: Validate Colour String
++# vld_color +vld_color("blue")#> [1] TRUEvld_color("glue")#> [1] FALSE+# vld_color +vld_colour("blue")#> [1] TRUEvld_colour("glue")#> [1] FALSE