Skip to contents

Color palettes collected in SCP.

Source: R/SCP-plot.R, R/utils.R
palette_scp.Rd

Color palettes collected in SCP.

Defined color palettes

Usage

palette_scp(
  x = NULL,
  n = 100,
  palette = "default",
  palcolor = NULL,
  type = "auto",
  NA_color = "grey80",
  NA_keep = FALSE,
  matched = FALSE,
  reverse = FALSE
)

palette_scp(
  x = NULL,
  n = 100,
  palette = "default",
  palcolor = NULL,
  type = "auto",
  NA_color = "grey80",
  NA_keep = FALSE,
  matched = FALSE,
  reverse = FALSE
)

Arguments

x

Either a character vector of color names/codes or a factor variable.

n

The number of colors to return for numeric values.

palette

A color palette name. Available options are:
"default", "default2", "category", "dimplot", "lace", ..., hue, grey, viridis, inferno, magma, plasma, cividis, ...
See also [`show_palettes`] for all available options.

palcolor

A character vector of colors. If palette is NULL and palcolor is specified, colors will be derived from the provided palcolor.

type

Type of x. Can be one of "auto", "discrete" or "continuous". The default is "auto", which automatically detects if x is a numeric value.

NA_color

Color used for NA values. Defaults to "grey80".

NA_keep

Logical. If FALSE, NA values in x will be excluded from the color palette, which ensures that the palette is applied only to non-NA values. If TRUE, NA values will be included in the palette and colored as NA_color.

matched

Logical. If TRUE, colors will be assigned based on a matching rule between values of x and available colors.

reverse

Logical. If TRUE, the color palette will be reversed.

Value

Returns a color palette based on the provided parameters.

See also

show_palettes palette_list

show_palettes

Examples

x <- c(1:3, NA, 3:5)
(pal1 <- palette_scp(x, palette = "Spectral"))
#>    [1,1.04] (1.04,1.08] (1.08,1.12] (1.12,1.16]  (1.16,1.2]  (1.2,1.24] (1.24,1.28] (1.28,1.32] (1.32,1.36]  (1.36,1.4] 
#>   "#5E4FA2"   "#5954A4"   "#555AA7"   "#5060AA"   "#4C66AC"   "#476BAF"   "#4371B2"   "#3E77B5"   "#3A7DB7"   "#3682BA" 
#>  (1.4,1.44] (1.44,1.48] (1.48,1.52] (1.52,1.56]  (1.56,1.6]  (1.6,1.64] (1.64,1.68] (1.68,1.72] (1.72,1.76]  (1.76,1.8] 
#>   "#3288BC"   "#378EBA"   "#3D94B7"   "#429AB5"   "#47A0B3"   "#4CA5B0"   "#52ABAE"   "#57B1AB"   "#5CB7A9"   "#61BDA6" 
#>  (1.8,1.84] (1.84,1.88] (1.88,1.92] (1.92,1.96]    (1.96,2]    (2,2.04] (2.04,2.08] (2.08,2.12] (2.12,2.16]  (2.16,2.2] 
#>   "#67C2A4"   "#6EC5A4"   "#75C8A4"   "#7CCAA4"   "#83CDA4"   "#8AD0A4"   "#91D2A4"   "#98D5A4"   "#9FD8A4"   "#A6DBA4" 
#>  (2.2,2.24] (2.24,2.28] (2.28,2.32] (2.32,2.36]  (2.36,2.4]  (2.4,2.44] (2.44,2.48] (2.48,2.52] (2.52,2.56]  (2.56,2.6] 
#>   "#ACDDA3"   "#B2E0A2"   "#B8E2A1"   "#BEE5A0"   "#C4E79E"   "#CAE99D"   "#D0EC9C"   "#D6EE9B"   "#DCF199"   "#E2F398" 
#>  (2.6,2.64] (2.64,2.68] (2.68,2.72] (2.72,2.76]  (2.76,2.8]  (2.8,2.84] (2.84,2.88] (2.88,2.92] (2.92,2.96]    (2.96,3] 
#>   "#E7F599"   "#E9F69D"   "#ECF7A1"   "#EEF8A5"   "#F1F9A9"   "#F3FAAD"   "#F6FBB1"   "#F8FCB5"   "#FBFDB9"   "#FDFEBD" 
#>    (3,3.04] (3.04,3.08] (3.08,3.12] (3.12,3.16]  (3.16,3.2]  (3.2,3.24] (3.24,3.28] (3.28,3.32] (3.32,3.36]  (3.36,3.4] 
#>   "#FEFDBC"   "#FEFAB7"   "#FEF7B1"   "#FEF4AC"   "#FEF0A7"   "#FEEDA2"   "#FEEA9C"   "#FEE797"   "#FEE492"   "#FEE18D" 
#>  (3.4,3.44] (3.44,3.48] (3.48,3.52] (3.52,3.56]  (3.56,3.6]  (3.6,3.64] (3.64,3.68] (3.68,3.72] (3.72,3.76]  (3.76,3.8] 
#>   "#FDDC88"   "#FDD784"   "#FDD27F"   "#FDCD7B"   "#FDC877"   "#FDC373"   "#FDBE6F"   "#FDB96A"   "#FDB466"   "#FDAF62" 
#>  (3.8,3.84] (3.84,3.88] (3.88,3.92] (3.92,3.96]    (3.96,4]    (4,4.04] (4.04,4.08] (4.08,4.12] (4.12,4.16]  (4.16,4.2] 
#>   "#FCA95E"   "#FBA25B"   "#FA9C58"   "#F99555"   "#F88F52"   "#F7884F"   "#F6824C"   "#F67B49"   "#F57446"   "#F46E43" 
#>  (4.2,4.24] (4.24,4.28] (4.28,4.32] (4.32,4.36]  (4.36,4.4]  (4.4,4.44] (4.44,4.48] (4.48,4.52] (4.52,4.56]  (4.56,4.6] 
#>   "#F16943"   "#EE6445"   "#EB5F46"   "#E85A47"   "#E45648"   "#E1514A"   "#DE4C4B"   "#DB474C"   "#D8434D"   "#D53E4E" 
#>  (4.6,4.64] (4.64,4.68] (4.68,4.72] (4.72,4.76]  (4.76,4.8]  (4.8,4.84] (4.84,4.88] (4.88,4.92] (4.92,4.96]    (4.96,5] 
#>   "#CF384D"   "#CA324C"   "#C42C4B"   "#BF2549"   "#B91F48"   "#B41947"   "#AE1345"   "#A90D44"   "#A30743"   "#9E0142" 
(pal2 <- palette_scp(x, palcolor = c("red", "white", "blue")))
#>    [1,1.04] (1.04,1.08] (1.08,1.12] (1.12,1.16]  (1.16,1.2]  (1.2,1.24] (1.24,1.28] (1.28,1.32] (1.32,1.36]  (1.36,1.4] 
#>   "#FF0000"   "#FF0505"   "#FF0A0A"   "#FF0F0F"   "#FF1414"   "#FF1919"   "#FF1E1E"   "#FF2424"   "#FF2929"   "#FF2E2E" 
#>  (1.4,1.44] (1.44,1.48] (1.48,1.52] (1.52,1.56]  (1.56,1.6]  (1.6,1.64] (1.64,1.68] (1.68,1.72] (1.72,1.76]  (1.76,1.8] 
#>   "#FF3333"   "#FF3838"   "#FF3D3D"   "#FF4242"   "#FF4848"   "#FF4D4D"   "#FF5252"   "#FF5757"   "#FF5C5C"   "#FF6161" 
#>  (1.8,1.84] (1.84,1.88] (1.88,1.92] (1.92,1.96]    (1.96,2]    (2,2.04] (2.04,2.08] (2.08,2.12] (2.12,2.16]  (2.16,2.2] 
#>   "#FF6767"   "#FF6C6C"   "#FF7171"   "#FF7676"   "#FF7B7B"   "#FF8080"   "#FF8585"   "#FF8B8B"   "#FF9090"   "#FF9595" 
#>  (2.2,2.24] (2.24,2.28] (2.28,2.32] (2.32,2.36]  (2.36,2.4]  (2.4,2.44] (2.44,2.48] (2.48,2.52] (2.52,2.56]  (2.56,2.6] 
#>   "#FF9A9A"   "#FF9F9F"   "#FFA4A4"   "#FFAAAA"   "#FFAFAF"   "#FFB4B4"   "#FFB9B9"   "#FFBEBE"   "#FFC3C3"   "#FFC8C8" 
#>  (2.6,2.64] (2.64,2.68] (2.68,2.72] (2.72,2.76]  (2.76,2.8]  (2.8,2.84] (2.84,2.88] (2.88,2.92] (2.92,2.96]    (2.96,3] 
#>   "#FFCECE"   "#FFD3D3"   "#FFD8D8"   "#FFDDDD"   "#FFE2E2"   "#FFE7E7"   "#FFECEC"   "#FFF2F2"   "#FFF7F7"   "#FFFCFC" 
#>    (3,3.04] (3.04,3.08] (3.08,3.12] (3.12,3.16]  (3.16,3.2]  (3.2,3.24] (3.24,3.28] (3.28,3.32] (3.32,3.36]  (3.36,3.4] 
#>   "#FCFCFF"   "#F7F7FF"   "#F2F2FF"   "#ECECFF"   "#E7E7FF"   "#E2E2FF"   "#DDDDFF"   "#D8D8FF"   "#D3D3FF"   "#CECEFF" 
#>  (3.4,3.44] (3.44,3.48] (3.48,3.52] (3.52,3.56]  (3.56,3.6]  (3.6,3.64] (3.64,3.68] (3.68,3.72] (3.72,3.76]  (3.76,3.8] 
#>   "#C8C8FF"   "#C3C3FF"   "#BEBEFF"   "#B9B9FF"   "#B4B4FF"   "#AFAFFF"   "#A9A9FF"   "#A4A4FF"   "#9F9FFF"   "#9A9AFF" 
#>  (3.8,3.84] (3.84,3.88] (3.88,3.92] (3.92,3.96]    (3.96,4]    (4,4.04] (4.04,4.08] (4.08,4.12] (4.12,4.16]  (4.16,4.2] 
#>   "#9595FF"   "#9090FF"   "#8B8BFF"   "#8585FF"   "#8080FF"   "#7B7BFF"   "#7676FF"   "#7171FF"   "#6C6CFF"   "#6767FF" 
#>  (4.2,4.24] (4.24,4.28] (4.28,4.32] (4.32,4.36]  (4.36,4.4]  (4.4,4.44] (4.44,4.48] (4.48,4.52] (4.52,4.56]  (4.56,4.6] 
#>   "#6161FF"   "#5C5CFF"   "#5757FF"   "#5252FF"   "#4D4DFF"   "#4848FF"   "#4242FF"   "#3D3DFF"   "#3838FF"   "#3333FF" 
#>  (4.6,4.64] (4.64,4.68] (4.68,4.72] (4.72,4.76]  (4.76,4.8]  (4.8,4.84] (4.84,4.88] (4.88,4.92] (4.92,4.96]    (4.96,5] 
#>   "#2E2EFF"   "#2929FF"   "#2424FF"   "#1E1EFF"   "#1919FF"   "#1414FF"   "#0F0FFF"   "#0A0AFF"   "#0505FF"   "#0000FF" 
(pal3 <- palette_scp(x, palette = "Spectral", n = 10))
#>   [1,1.4] (1.4,1.8] (1.8,2.2] (2.2,2.6]   (2.6,3]   (3,3.4] (3.4,3.8] (3.8,4.2] (4.2,4.6]   (4.6,5] 
#> "#5E4FA2" "#3288BD" "#66C2A5" "#ABDDA4" "#E6F598" "#FFFFBF" "#FEE08B" "#FDAE61" "#F46D43" "#D53E4F" 
(pal4 <- palette_scp(x, palette = "Spectral", n = 10, reverse = TRUE))
#>   (4.6,5] (4.2,4.6] (3.8,4.2] (3.4,3.8]   (3,3.4]   (2.6,3] (2.2,2.6] (1.8,2.2] (1.4,1.8]   [1,1.4] 
#> "#D53E4F" "#F46D43" "#FDAE61" "#FEE08B" "#FFFFBF" "#E6F598" "#ABDDA4" "#66C2A5" "#3288BD" "#5E4FA2" 
(pal5 <- palette_scp(x, palette = "Spectral", matched = TRUE))
#>  [1,1.04]  (1.96,2]  (2.96,3]      <NA>  (2.96,3]  (3.96,4]  (4.96,5] 
#> "#5E4FA2" "#83CDA4" "#FDFEBD"        NA "#FDFEBD" "#F88F52" "#9E0142" 
(pal6 <- palette_scp(x, palette = "Spectral", matched = TRUE, NA_keep = TRUE))
#>  [1,1.04]  (1.96,2]  (2.96,3]      <NA>  (2.96,3]  (3.96,4]  (4.96,5] 
#> "#5E4FA2" "#83CDA4" "#FDFEBD"  "grey80" "#FDFEBD" "#F88F52" "#9E0142" 
(pal7 <- palette_scp(x, palette = "Paired", type = "discrete"))
#>         1         2         3         4         5 
#> "#A6CEE3" "#1F78B4" "#B2DF8A" "#33A02C" "#FDBF6F" 
show_palettes(list(pal1, pal2, pal3, pal4, pal5, pal6, pal7))
#> All available palettes:
#> Error in if (!is.null(names(pal)) && all(names(pal) != "")) {    graphics::text((j - 1) * show_step + show_rect/2, 0.5, names(pal)[j],         srt = 90, adj = 0.5, cex = 0.5)} else {    graphics::text((j - 1) * show_step + show_rect/2, 0.5, pal[j],         srt = 90, adj = 0.5, cex = 0.5)}: missing value where TRUE/FALSE needed

all_palettes <- show_palettes(return_palettes = TRUE)

#> Error in show_palettes(return_palettes = TRUE): unused argument (return_palettes = TRUE)
names(all_palettes)
#> Error: object 'all_palettes' not found

show_palettes(list(
  "palette_default" = palette_default,
  "palette_dimplot" = palette_dimplot
))
#> All available palettes:
#> palette_default
#> palette_dimplot

pal1 <- palette_scp(x = letters[1:10], palette = "default")
#> Error in palette_scp(x = letters[1:10], palette = "default"): The palette name (default) is invalid! You can check the available palette names with 'show_palettes()'. Or pass palette colors via the 'palcolor' parameter.
pal1
#>    [1,1.04] (1.04,1.08] (1.08,1.12] (1.12,1.16]  (1.16,1.2]  (1.2,1.24] (1.24,1.28] (1.28,1.32] (1.32,1.36]  (1.36,1.4] 
#>   "#5E4FA2"   "#5954A4"   "#555AA7"   "#5060AA"   "#4C66AC"   "#476BAF"   "#4371B2"   "#3E77B5"   "#3A7DB7"   "#3682BA" 
#>  (1.4,1.44] (1.44,1.48] (1.48,1.52] (1.52,1.56]  (1.56,1.6]  (1.6,1.64] (1.64,1.68] (1.68,1.72] (1.72,1.76]  (1.76,1.8] 
#>   "#3288BC"   "#378EBA"   "#3D94B7"   "#429AB5"   "#47A0B3"   "#4CA5B0"   "#52ABAE"   "#57B1AB"   "#5CB7A9"   "#61BDA6" 
#>  (1.8,1.84] (1.84,1.88] (1.88,1.92] (1.92,1.96]    (1.96,2]    (2,2.04] (2.04,2.08] (2.08,2.12] (2.12,2.16]  (2.16,2.2] 
#>   "#67C2A4"   "#6EC5A4"   "#75C8A4"   "#7CCAA4"   "#83CDA4"   "#8AD0A4"   "#91D2A4"   "#98D5A4"   "#9FD8A4"   "#A6DBA4" 
#>  (2.2,2.24] (2.24,2.28] (2.28,2.32] (2.32,2.36]  (2.36,2.4]  (2.4,2.44] (2.44,2.48] (2.48,2.52] (2.52,2.56]  (2.56,2.6] 
#>   "#ACDDA3"   "#B2E0A2"   "#B8E2A1"   "#BEE5A0"   "#C4E79E"   "#CAE99D"   "#D0EC9C"   "#D6EE9B"   "#DCF199"   "#E2F398" 
#>  (2.6,2.64] (2.64,2.68] (2.68,2.72] (2.72,2.76]  (2.76,2.8]  (2.8,2.84] (2.84,2.88] (2.88,2.92] (2.92,2.96]    (2.96,3] 
#>   "#E7F599"   "#E9F69D"   "#ECF7A1"   "#EEF8A5"   "#F1F9A9"   "#F3FAAD"   "#F6FBB1"   "#F8FCB5"   "#FBFDB9"   "#FDFEBD" 
#>    (3,3.04] (3.04,3.08] (3.08,3.12] (3.12,3.16]  (3.16,3.2]  (3.2,3.24] (3.24,3.28] (3.28,3.32] (3.32,3.36]  (3.36,3.4] 
#>   "#FEFDBC"   "#FEFAB7"   "#FEF7B1"   "#FEF4AC"   "#FEF0A7"   "#FEEDA2"   "#FEEA9C"   "#FEE797"   "#FEE492"   "#FEE18D" 
#>  (3.4,3.44] (3.44,3.48] (3.48,3.52] (3.52,3.56]  (3.56,3.6]  (3.6,3.64] (3.64,3.68] (3.68,3.72] (3.72,3.76]  (3.76,3.8] 
#>   "#FDDC88"   "#FDD784"   "#FDD27F"   "#FDCD7B"   "#FDC877"   "#FDC373"   "#FDBE6F"   "#FDB96A"   "#FDB466"   "#FDAF62" 
#>  (3.8,3.84] (3.84,3.88] (3.88,3.92] (3.92,3.96]    (3.96,4]    (4,4.04] (4.04,4.08] (4.08,4.12] (4.12,4.16]  (4.16,4.2] 
#>   "#FCA95E"   "#FBA25B"   "#FA9C58"   "#F99555"   "#F88F52"   "#F7884F"   "#F6824C"   "#F67B49"   "#F57446"   "#F46E43" 
#>  (4.2,4.24] (4.24,4.28] (4.28,4.32] (4.32,4.36]  (4.36,4.4]  (4.4,4.44] (4.44,4.48] (4.48,4.52] (4.52,4.56]  (4.56,4.6] 
#>   "#F16943"   "#EE6445"   "#EB5F46"   "#E85A47"   "#E45648"   "#E1514A"   "#DE4C4B"   "#DB474C"   "#D8434D"   "#D53E4E" 
#>  (4.6,4.64] (4.64,4.68] (4.68,4.72] (4.72,4.76]  (4.76,4.8]  (4.8,4.84] (4.84,4.88] (4.88,4.92] (4.92,4.96]    (4.96,5] 
#>   "#CF384D"   "#CA324C"   "#C42C4B"   "#BF2549"   "#B91F48"   "#B41947"   "#AE1345"   "#A90D44"   "#A30743"   "#9E0142" 
show_colors(pal1)
#> Error in show_colors(pal1): could not find function "show_colors"
pal2 <- palette_scp(x = letters[1:10], palette = "default", reverse = TRUE)
#> Error in palette_scp(x = letters[1:10], palette = "default", reverse = TRUE): The palette name (default) is invalid! You can check the available palette names with 'show_palettes()'. Or pass palette colors via the 'palcolor' parameter.
pal2
#>    [1,1.04] (1.04,1.08] (1.08,1.12] (1.12,1.16]  (1.16,1.2]  (1.2,1.24] (1.24,1.28] (1.28,1.32] (1.32,1.36]  (1.36,1.4] 
#>   "#FF0000"   "#FF0505"   "#FF0A0A"   "#FF0F0F"   "#FF1414"   "#FF1919"   "#FF1E1E"   "#FF2424"   "#FF2929"   "#FF2E2E" 
#>  (1.4,1.44] (1.44,1.48] (1.48,1.52] (1.52,1.56]  (1.56,1.6]  (1.6,1.64] (1.64,1.68] (1.68,1.72] (1.72,1.76]  (1.76,1.8] 
#>   "#FF3333"   "#FF3838"   "#FF3D3D"   "#FF4242"   "#FF4848"   "#FF4D4D"   "#FF5252"   "#FF5757"   "#FF5C5C"   "#FF6161" 
#>  (1.8,1.84] (1.84,1.88] (1.88,1.92] (1.92,1.96]    (1.96,2]    (2,2.04] (2.04,2.08] (2.08,2.12] (2.12,2.16]  (2.16,2.2] 
#>   "#FF6767"   "#FF6C6C"   "#FF7171"   "#FF7676"   "#FF7B7B"   "#FF8080"   "#FF8585"   "#FF8B8B"   "#FF9090"   "#FF9595" 
#>  (2.2,2.24] (2.24,2.28] (2.28,2.32] (2.32,2.36]  (2.36,2.4]  (2.4,2.44] (2.44,2.48] (2.48,2.52] (2.52,2.56]  (2.56,2.6] 
#>   "#FF9A9A"   "#FF9F9F"   "#FFA4A4"   "#FFAAAA"   "#FFAFAF"   "#FFB4B4"   "#FFB9B9"   "#FFBEBE"   "#FFC3C3"   "#FFC8C8" 
#>  (2.6,2.64] (2.64,2.68] (2.68,2.72] (2.72,2.76]  (2.76,2.8]  (2.8,2.84] (2.84,2.88] (2.88,2.92] (2.92,2.96]    (2.96,3] 
#>   "#FFCECE"   "#FFD3D3"   "#FFD8D8"   "#FFDDDD"   "#FFE2E2"   "#FFE7E7"   "#FFECEC"   "#FFF2F2"   "#FFF7F7"   "#FFFCFC" 
#>    (3,3.04] (3.04,3.08] (3.08,3.12] (3.12,3.16]  (3.16,3.2]  (3.2,3.24] (3.24,3.28] (3.28,3.32] (3.32,3.36]  (3.36,3.4] 
#>   "#FCFCFF"   "#F7F7FF"   "#F2F2FF"   "#ECECFF"   "#E7E7FF"   "#E2E2FF"   "#DDDDFF"   "#D8D8FF"   "#D3D3FF"   "#CECEFF" 
#>  (3.4,3.44] (3.44,3.48] (3.48,3.52] (3.52,3.56]  (3.56,3.6]  (3.6,3.64] (3.64,3.68] (3.68,3.72] (3.72,3.76]  (3.76,3.8] 
#>   "#C8C8FF"   "#C3C3FF"   "#BEBEFF"   "#B9B9FF"   "#B4B4FF"   "#AFAFFF"   "#A9A9FF"   "#A4A4FF"   "#9F9FFF"   "#9A9AFF" 
#>  (3.8,3.84] (3.84,3.88] (3.88,3.92] (3.92,3.96]    (3.96,4]    (4,4.04] (4.04,4.08] (4.08,4.12] (4.12,4.16]  (4.16,4.2] 
#>   "#9595FF"   "#9090FF"   "#8B8BFF"   "#8585FF"   "#8080FF"   "#7B7BFF"   "#7676FF"   "#7171FF"   "#6C6CFF"   "#6767FF" 
#>  (4.2,4.24] (4.24,4.28] (4.28,4.32] (4.32,4.36]  (4.36,4.4]  (4.4,4.44] (4.44,4.48] (4.48,4.52] (4.52,4.56]  (4.56,4.6] 
#>   "#6161FF"   "#5C5CFF"   "#5757FF"   "#5252FF"   "#4D4DFF"   "#4848FF"   "#4242FF"   "#3D3DFF"   "#3838FF"   "#3333FF" 
#>  (4.6,4.64] (4.64,4.68] (4.68,4.72] (4.72,4.76]  (4.76,4.8]  (4.8,4.84] (4.84,4.88] (4.88,4.92] (4.92,4.96]    (4.96,5] 
#>   "#2E2EFF"   "#2929FF"   "#2424FF"   "#1E1EFF"   "#1919FF"   "#1414FF"   "#0F0FFF"   "#0A0AFF"   "#0505FF"   "#0000FF" 
show_colors(pal2)
#> Error in show_colors(pal2): could not find function "show_colors"