inst/doc/inst_colors.R

## ----setup, include = FALSE---------------------------------------------------
options(max.print = "75")

knitr::opts_chunk$set(echo = TRUE,
                      cache = FALSE,
                      prompt = FALSE,
                      tidy = FALSE,
                      collapse = TRUE, 
                      comment = "#>",
                      message = FALSE,
                      warning = FALSE,
                      # Default figure options:
                      # fig.width = 6, 
                      # fig.asp = .80 # .618, # golden ratio
                      fig.align = "center",
                      out.width = "60%"
)

# URLs: ------ 

# unikn / Uni Konstanz:
url_unikn <- "https://www.uni-konstanz.de"

# unikn package:
url_unikn_cran   <- "https://CRAN.R-project.org/package=unikn"
url_unikn_github <- "https://github.com/hneth/unikn"

# unicol package: 
url_unicol_cran   <- "https://CRAN.R-project.org/package=unicol"
url_unicol_github <- "https://github.com/hneth/unicol"

## ----load-pkg-colors, message = FALSE, warning = FALSE------------------------
# install.packages('unikn')  # install unikn from CRAN client
library('unikn')             # load the package

## ----def-col-mpg-pal-local, echo = FALSE--------------------------------------
mpg_pal <- newpal(col = c(rgb( 17, 102,  86, maxColorValue = 255), "white", "#DDDED6"),
                  names = c("MPG green", "white", "MPG grey"),
                  as_df = FALSE)

## ----def-col-mpg-example, echo = FALSE, fig.width = 4.5, fig.asp = 1, fig.align = 'center'----
seecol(pal = mpg_pal, col_brd = "black", lwd_brd = .5)

## ----def-col-rgb--------------------------------------------------------------
mpg_green <- grDevices::rgb( 17, 102,  86, maxColorValue = 255)
mpg_grey  <- grDevices::rgb(221, 222, 214, maxColorValue = 255)

## ----def-col-rgb-eval---------------------------------------------------------
mpg_green
mpg_grey

## ----def-col-hex--------------------------------------------------------------
mpg_green_2 <- "#116656"
mpg_grey_2  <- "#DDDED6"

## ----def-col-rgb-hex-eual-----------------------------------------------------
all.equal(mpg_green, mpg_green_2)
all.equal(mpg_grey,  mpg_grey_2)

## ----cols-to-pals-------------------------------------------------------------
c(mpg_green, mpg_grey)
data.frame(mpg_green, mpg_grey)

## ----newpal-mpg-3, fig.width = 4.5, fig.asp = 1, fig.align = 'center'---------
mpg_pal_3 <- newpal(col = c(rgb( 17, 102,  86, maxColorValue = 255), "white", "#DDDED6"),
                    names = c("MPG green", "white", "MPG grey"),
                    as_df = FALSE)

## ----seecol-mpg-3, fig.width = 4.5, fig.asp = 1, fig.align = 'center'---------
seecol(mpg_pal_3, 
       main = "My new color palette", col_brd = "black", lwd_brd = .5)

## ----newpal-mpg-5-------------------------------------------------------------
my_mpg_pal <- usecol(mpg_pal_3, n = 5)

## ----seecol-mpg-5, fig.width = 4.5, fig.asp = 1, fig.align = 'center'---------
seecol(my_mpg_pal, main = "My new MPG color palette", 
       col_brd = "black", lwd_brd = .5)

## ----verify-equality----------------------------------------------------------
all.equal(col2rgb(mpg_pal), col2rgb(my_mpg_pal), check.attributes = FALSE)

## ----compare-custom-pals, eval = TRUE, fig.width = 4.5, fig.asp = .55, fig.align = 'center', collapse = TRUE----
# Scaled palettes: 
seecol(list(mpg_pal, pal_unikn), n = 7,
       pal_names = c("Max Planck", "Uni Konstanz"),
       main = "Comparing scaled color palettes")

Try the unikn package in your browser

Any scripts or data that you put into this service are public.

unikn documentation built on May 29, 2024, 10:41 a.m.