Package 'unhcrthemes'

UNHCR color palettes viewer

Description

Displays a set of the color palettes from UNHCR color

Usage

display_unhcr_all(n = NULL, type = "all")

Arguments

n	Number of different colors in the palette, minimum depending on the palette (2), maximum depending on the palette (5, 7 or 10)
type	Type of the palette, can be "sequential", "diverging", "qualitative" or "all"

Value

No return value, called for side effects

Examples

library(unhcrthemes)
display_unhcr_all()
display_unhcr_all(type = "diverging")
display_unhcr_all(type = c("diverging", "qualitative", "sequential"))
display_unhcr_all(n = 3, type = "sequential")
display_unhcr_all(n = 5, type = "sequential")

---

UNHCR color palette viewer

Description

Displays a color palette from UNHCR brand color

Usage

display_unhcr_pal(n = NULL, name)

Arguments

n	Number of different colors in the palette, minimum depending on palette (2), maximum depending on palette (5, 7 or 10)
name	A palette name

Value

No return value, called for side effects

Examples

display_unhcr_pal(3, "pal_unhcr")

---

Import Lato font

Description

Import Lato font for use in R graphic devices

Usage

import_lato()

Value

No return value, called for side effects

---

Check if Lato font is installed in the system

Description

Verify if you have Lato font installed in your system

Usage

lato_installed()

Value

TRUE if Lato is installed in the system

---

Check if Lato font is registered through extrafont

Description

Verify if Lato is registered through extrafont

Usage

lato_registered()

Value

TRUE if Lato is registered

---

UNHCR ggplot2 color scales

Description

UNHCR ggplot2 color scales

Usage

scale_color_unhcr_c(
  ...,
  type = "sequential",
  palette = 1,
  direction = 1,
  na.value = "#E9E9E9",
  guide = "colourbar"
)

scale_color_unhcr_d(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9"
)

scale_color_unhcr_b(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9",
  guide = "coloursteps"
)

scale_colour_unhcr_c(
  ...,
  type = "sequential",
  palette = 1,
  direction = 1,
  na.value = "#E9E9E9",
  guide = "colourbar"
)

scale_colour_unhcr_d(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9"
)

scale_colour_unhcr_b(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9",
  guide = "coloursteps"
)

scale_fill_unhcr_c(
  ...,
  type = "sequential",
  palette = 1,
  direction = 1,
  na.value = "#E9E9E9",
  guide = "colourbar"
)

scale_fill_unhcr_d(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9"
)

scale_fill_unhcr_b(
  ...,
  type = "qualitative",
  palette = 1,
  direction = 1,
  nmax = NULL,
  order = NULL,
  na.value = "#E9E9E9",
  guide = "coloursteps"
)

Arguments

...	Other arguments passed on to discrete_scale() or continuous_scale() to control name, limits, breaks, labels and so forth
type	One of \"sequential\", \"diverging\" or \"qualitative\"
palette	If a string, will use that named palette. If a number, will index into the list of palettes of appropriate type
direction	Sets the order of colors in the scale. If 1, the default, colors are as output by unhcr_pal(). If -1, the order of colors is reversed
na.value	Missing values will be replaced with this value.
guide	A function used to create a guide or its name. See guides() for more information.
nmax	Maximum number of different colors the palette should contain. If not provided, is calculated automatically from the data.
order	Numeric vector listing the order in which the colors should be used. Default is 1:nmax.

Value

A discrete, continuous or binned Scale object

Examples

library(ggplot2)

data(msleep, package = "ggplot2")

ggplot(msleep, aes(vore, sleep_total, fill = vore)) +
  geom_boxplot() +
  scale_fill_unhcr_d(palette = 1, direction = -1)

---

UNHCR ggplot2 theme

Description

theme_unhcr provides a basic UNHCR theme to use in ggplot2 commands.

Usage

theme_unhcr(
  font_family = if (lato_installed()) "Lato" else "sans",
  font_size = 12,
  plot_title_size = rel(1.35),
  plot_title_margin = font_size,
  subtitle_size = font_size,
  subtitle_margin = font_size * 1.5,
  strip_text_size = rel(0.9),
  strip_text_face = "bold",
  strip_text_just = 0,
  caption_size = rel(0.7),
  caption_margin = font_size,
  axis_text = TRUE,
  axis_text_size = rel(0.9),
  axis_title = TRUE,
  axis_title_size = rel(0.9),
  axis = FALSE,
  axis_ticks = FALSE,
  grid = "XY",
  legend = TRUE,
  legend_text_size = rel(0.9),
  legend_title = FALSE,
  legend_title_size = rel(0.9),
  plot_margin = margin(font_size, font_size, font_size, font_size),
  plot_background = "#ffffff",
  void = FALSE
)

Arguments

font_family	Base font family "Lato". You need to have "Lato" font installed on your device in order to use it.
font_size	Base font size in pt. Default to 12 pts.
plot_title_size	Plot title font size. Default to font_size * 1.35.
plot_title_margin	Plot title bottom margin. Default to font_size.
subtitle_size	Plot subtitle font size. Default to font_size.
subtitle_margin	Plot subtitle bottom margin. Default to font_size * 1.5.
strip_text_size	Facet label font size. Default to font_size * 0.9.
strip_text_face	Facet label font face. Default to "bold".
strip_text_just	Facet label justification. Default to 0.
caption_size	Caption font size. Default to font_size * 0.7.
caption_margin	Caption top margin. Default to font_size.
axis_text	Logical TRUE/FALSE or xy. Turn on and off axis label. Use x or y to have only the correspondent active. Default to TRUE.
axis_text_size	Axis label font size. Default to font_size * 0.9.
axis_title	Logical TRUE/FALSE or xy. Turn on and off axis title. Use x or y to have only the correspondent active. Default to TRUE.
axis_title_size	Axis title font size. Default to font_size * 0.9.
axis	Logical TRUE/FALSE or xy. Turn on and off axis. Use x or y to have only the correspondent axis active. Don't forget to review the expand argument of the ⁠scale_x_*⁠/⁠scale_y_*⁠ to avoid spacing between the axis and the baseline of the plot. Default to FALSE.
axis_ticks	Logical TRUE/FALSE or xy. Turn on and off axis ticks. Use x or y to have only the correspondent axis ticks active. Default to FALSE.
grid	Logical TRUE/FALSE or a combination of X or x and Y or y⁠. Turn on and off panel grids. Use ⁠XorY⁠for major grids, and⁠xory⁠for minor grid. Default to⁠XY'.
legend	Logical TRUE/FALSE. Turn on and off the legend. Default to TRUE.
legend_text_size	Legend key font size. Default to font_size * 0.9.
legend_title	Logical TRUE/FALSE. Turn on and off the legend title. Default to FALSE.
legend_title_size	Legend title font size. Default to font_size * 0.9.
plot_margin	Plot margin (specify with ggplot2::margin()). Default to ggplot2::margin(font_size, font_size, font_size, font_size).
plot_background	Plot background. Put "transparent" for no background color. Default to "white".
void	Logical TRUE/FALSE. If TRUE, all grid lines, ticks and axes are removed. Default to FALSE.

Value

A ggplot2 theme object, the theme style.

Examples

## Not run: 

library(ggplot2)

data(mpg, package = "ggplot2")

ggplot(mpg, aes(displ, hwy)) +
  geom_point() +
  theme_unhcr()

## End(Not run)

---

UNHCR color palettes

Description

Creates a color palette from UNHCR branding

Usage

unhcr_pal(n = NULL, name, ...)

Arguments

n	Number of different colors in the palette, minimum depending on palette (2), maximum depending on palette (5, 7 or 10)
name	A palette name
...	Additional arguments for grDevices::colorRampPalette

Value

A character vector, the palette hex color codes.

Examples

unhcr_pal(3, "pal_unhcr")
unhcr_pal(3, "pal_blue")
unhcr_pal(5, "pal_navy")
unhcr_pal(12, "pal_red")

---