Package {ipeaplot}

ipeaplot: ggplot Graphics in Ipea Standard

Description

Convenient functions to create ggplot graphics following the editorial guidelines of the Institute for Applied Economic Research - Ipea.

Usage

Please check the vignettes and data documentation on the website.

Author(s)

Maintainer: Pedro Ferreira pedro.ferreira2@ipea.gov.br

Authors:

• Pedro Ferreira pedro.ferreira2@ipea.gov.br

• Pedro Jorge pedro.alves@ipea.gov.br

• Daniel Lima daniel.viegas@ipea.gov.br

• Gustavo Coelho gustavo.coelho@ipea.gov.br

• Rafael H. M. Pereira rafa.pereira.br@gmail.com

• Lucas Mation lucas.mation@ipea.gov.br

Other contributors:

• Fabio Vaz fabio.vaz@ipea.gov.br [contributor]

• Ipea - Institue for Applied Economic Research [copyright holder, funder]

See Also

Useful links:

• https://github.com/ipeadata-lab/ipeaplot

• Report bugs at https://github.com/ipeadata-lab/ipeaplot/issues

Contrasting text colour for labels drawn over a fill colour

Description

Given one or more fill/background colours, returns "white" or "black", whichever gives better contrast against that background. Useful for value labels drawn inside bars or over points/lines, matching the Ipea editorial guidelines for graphics, which alternate the colour of data labels according to how dark the colour behind them is. See https://www.ipea.gov.br/manualeditorial/padroes/padroes-grafico-visuais/ilustracoes-pi.html.

Usage

ipea_contrast_color(background)

Arguments

Value

A character vector the same length as background, containing "white" or "black".

See Also

Other ggplot2 theme functions: ipea_label_size(), scale_color_ipea(), scale_fill_ipea(), theme_ipea()

Examples

ipea_contrast_color(c("#29112F", "#D2A0C9"))

library(ggplot2)
df <- data.frame(grupo = c("A", "B"), valor = c(22.6, 4.7),
                  cor = c("#29112F", "#D2A0C9"))
ggplot(df, aes(grupo, valor, fill = cor, label = valor)) +
  geom_col() +
  geom_text(aes(color = ipea_contrast_color(cor)), size = ipea_label_size(),
            fontface = "bold") +
  scale_fill_identity() +
  scale_color_identity() +
  theme_ipea()

Font size for data labels in Ipea graphics

Description

Converts a font size in points (pt) into the size argument/aesthetic (in mm) expected by ggplot2::geom_text(), ggplot2::geom_label() and similar geoms. ggplot2 specifies text size for geoms in mm and internally converts it to points by multiplying by 2.845276 (72.27/25.4); this helper performs the inverse conversion so that labels are rendered at an exact point size.

Usage

ipea_label_size(pt = 6)

Arguments

Value

A numeric value (in mm) to be passed to the size argument/aesthetic of ggplot2::geom_text(), ggplot2::geom_label() or similar geoms.

See Also

Other ggplot2 theme functions: ipea_contrast_color(), scale_color_ipea(), scale_fill_ipea(), theme_ipea()

Examples

library(ggplot2)
ggplot(mtcars[1:5, ], aes(hp, mpg, label = round(mpg))) +
  geom_text(size = ipea_label_size(), colour = "black") +
  theme_ipea()

Ipea palette

Description

Ipea palette

Usage

ipea_pal(
  palette = c("Blue", "Green", "Orange", "Pink", "Pink-Deep", "Green-Blue",
    "Green-Blue-White", "Red-Blue", "Red-Blue-White", "Orange-Blue", "Orange-Blue-White",
    "Viridis", "Inferno", "Magma", "Plasma", "Cividis", "NT", "NT-Categorical", "TD",
    "TD-Categorical"),
  alpha = 1,
  begin = 0,
  end = 1,
  palette_direction = 1
)

Arguments

Value

ipea_palette produces a character vector, cv, containing color hex codes. This vector can be utilized to establish a custom color scheme for future graphics using palette(cv), or it can be applied directly as a col = parameter in graphic functions or within par.

References

'Blue','Green','Orange','Pink','Pink-Deep','Green-Blue','Green-Blue-White','Red-Blue','Red-Blue-White', 'Orange-Blue','Orange-Blue-White', 'Viridis','Inferno', 'Magma','Plasma' and 'Cividis': https://pmassicotte.github.io/paletteer_gallery/ 'NT'/'TD' and their '-Categorical' variants: see ipea_palette().

Examples

scales::show_col(ipea_pal()(10))
scales::show_col(ipea_pal(palette_direction = -1)(6))
scales::show_col(ipea_pal(begin = 0.2, end = 0.8)(4))
scales::show_col(ipea_pal(palette = "Green")(6))
scales::show_col(ipea_pal(palette = "NT")(10))
scales::show_col(ipea_pal(palette = "TD-Categorical")(12))

Ipea Color Palette and Scales

Description

This function creates a vector of n equally spaced colors along the selected color map.

Usage

ipea_palette(
  palette = c("Blue", "Green", "Orange", "Pink", "Pink-Deep", "Green-Blue",
    "Green-Blue-White", "Red-Blue", "Red-Blue-White", "Orange-Blue", "Orange-Blue-White",
    "Viridis", "Inferno", "Magma", "Plasma", "Cividis", "NT", "NT-Categorical", "TD",
    "TD-Categorical"),
  n,
  alpha = 1,
  begin = 0,
  end = 1,
  palette_direction = 1
)

Arguments

Details

A 9-color Ipea palette.

Value

ipea_palette produces a character vector, cv, containing color hex codes. This vector can be utilized to establish a custom color scheme for future graphics using palette(cv), or it can be applied directly as a col = parameter in graphic functions or within par.

References

'Blue','Green','Orange','Pink','Pink-Deep','Green-Blue','Green-Blue-White','Red-Blue','Red-Blue-White', 'Orange-Blue','Orange-Blue-White', 'Viridis','Inferno', 'Magma','Plasma' and 'Cividis': https://pmassicotte.github.io/paletteer_gallery/ 'NT' and 'TD' are sequential palettes taken from the cover, section-title and chart colours of two Ipea editorial series (Nota Tecnica and Texto para Discussao, respectively). 'NT-Categorical' and 'TD-Categorical' are qualitative 12-colour sets built from the same two publications, interleaving 6 shades of each of their two hues so that adjacent categories stay visually distinct. scale_color_ipea()/scale_fill_ipea() switch automatically from 'NT'/'TD' to their '-Categorical' variant when the mapped variable is discrete, so most users never need to type the '-Categorical' suffix themselves.

Save ggplot in multiple formats

Description

Unified function to save ggplot objects in one or more formats.

Usage

save_ipeaplot(
  gplot = ggplot2::last_plot(),
  file.name,
  format = NULL,
  width = 6.3,
  height = 3.94,
  units = c("in", "mm", "cm", "px"),
  dpi = 300,
  background = "white",
  quality = 95,
  path = ".",
  scale = 1,
  overwrite = TRUE,
  include_date = FALSE,
  date_format = "%Y%m%d",
  use_cairo = TRUE,
  use_ragg = TRUE,
  quiet = TRUE,
  ...
)

Arguments

Value

Named (invisible) vector with the paths of the saved files.

Scale color IPEA

Description

Generate a color palette (continuous or discrete) following the editorial guidelines used by the Institute for Applied Economic Research - Ipea.

Usage

scale_color_ipea(
  palette = c("Blue", "Green", "Orange", "Pink", "Pink-Deep", "Green-Blue",
    "Green-Blue-White", "Red-Blue", "Red-Blue-White", "Orange-Blue", "Orange-Blue-White",
    "Viridis", "Inferno", "Magma", "Plasma", "Cividis", "NT", "NT-Categorical", "TD",
    "TD-Categorical"),
  palette_direction = 1,
  decimal.mark = ",",
  barheight = NULL,
  barwidth = NULL,
  title.hjust = NULL,
  label.hjust = NULL,
  ...
)

Arguments

Value

A list object be added to a ggplot object to change color pallete.

See Also

Other ggplot2 theme functions: ipea_contrast_color(), ipea_label_size(), scale_fill_ipea(), theme_ipea()

Examples

# Creating scale for ggplot2 graph using default arguments
library(ggplot2)
fig_raw <- ggplot() +
  geom_point(data = mtcars, aes(x = hp , y = mpg, color = cyl)) +
  scale_color_ipea()

# Creating scale for ggplot2 graph using green sequential palette
fig_raw <- ggplot() +
  geom_point(data = mtcars, aes(x = hp , y = mpg, color = cyl)) +
  scale_color_ipea(palette = "Green")

# "NT" uses the sequential magenta ramp for a numeric variable, and the
# 12-colour qualitative set for a discrete one, automatically
fig_raw <- ggplot() +
  geom_point(data = mtcars, aes(x = hp , y = mpg, color = factor(cyl))) +
  scale_color_ipea(palette = "NT")

Scale fill IPEA

Description

Generate a fill palette (continuous or discrete) in the formatting of texts published by the Institute for Applied Economic Research (IPEA)

Usage

scale_fill_ipea(
  palette = c("Blue", "Green", "Orange", "Pink", "Pink-Deep", "Green-Blue",
    "Green-Blue-White", "Red-Blue", "Red-Blue-White", "Orange-Blue", "Orange-Blue-White",
    "Viridis", "Inferno", "Magma", "Plasma", "Cividis", "NT", "NT-Categorical", "TD",
    "TD-Categorical"),
  palette_direction = 1,
  decimal.mark = ",",
  barheight = NULL,
  barwidth = NULL,
  title.hjust = NULL,
  label.hjust = NULL,
  ...
)

Arguments

Value

A list object be added to a ggplot object to change color pallete.

See Also

Other ggplot2 theme functions: ipea_contrast_color(), ipea_label_size(), scale_color_ipea(), theme_ipea()

Examples

# Creating scale for ggplot2 graph using default arguments
library(ggplot2)
fig_raw <- ggplot() +
  geom_col(data = mtcars, aes(x = hp , y = mpg, fill = cyl)) +
  scale_fill_ipea()

# Creating scale for ggplot2 graph using green sequential palette
fig_raw <- ggplot() +
  geom_col(data = mtcars, aes(x = hp , y = mpg, fill = cyl)) +
  scale_fill_ipea(palette = "Green")

# "TD" uses the sequential blue ramp for a numeric variable, and the
# 12-colour qualitative set for a discrete one, automatically
fig_raw <- ggplot() +
  geom_col(data = mtcars, aes(x = hp , y = mpg, fill = factor(cyl))) +
  scale_fill_ipea(palette = "TD")

Ggplot theme for Ipea charts and figures

Description

Applies a custom theme for ggplot figures following the editorial guidelines used by the Institute for Applied Economic Research - Ipea. The function includes standardized formatting of options for axis lines, text,

Usage

theme_ipea(
  axis_lines = "full",
  axis_values = TRUE,
  legend.position = "bottom",
  grid.adjust = "horizontal",
  x_breaks = NULL,
  y_breaks = NULL,
  expand_x_limit = TRUE,
  expand_y_limit = TRUE,
  x_text_angle = 0,
  include_x_text_title = TRUE,
  include_y_text_title = TRUE,
  include_ticks = TRUE,
  ...
)

Arguments

Value

A custom theme for IPEA graphics.

See Also

Other ggplot2 theme functions: ipea_contrast_color(), ipea_label_size(), scale_color_ipea(), scale_fill_ipea()

Examples

# Creating theme for ggplot2 graph using default arguments
library(ggplot2)
fig_raw <- ggplot() +
  geom_col(data = mtcars, aes(x = hp , y = mpg, fill = cyl)) +
  theme_ipea()