Skip to contents

Theme Elements for Image Grobs

Source: R/theme_elements.R
element_sdv.Rd

In conjunction with the ggplot2::theme system, the following element_ functions enable images in non-data components of the plot, e.g. axis text.

  • element_sdv_logo(): draws team logos instead of their abbreviations.

  • element_sdv_wordmark(): draws team wordmarks instead of their abbreviations.

  • element_sdv_headshot(): draws player headshots instead of their IDs.

  • element_sdv_raster(): draws a single image in a rectangular theme element such as plot.background. A thin wrapper around ggpath::element_raster().

Usage

element_sdv_logo(
  sport = c("nfl", "nba", "wnba", "mlb", "nhl", "cfb", "mbb", "wbb"),
  alpha = NULL,
  colour = NA,
  color = NULL,
  hjust = NULL,
  vjust = NULL,
  size = 0.5
)

element_sdv_wordmark(
  sport = c("nfl", "nba", "wnba", "mlb", "nhl", "cfb", "mbb", "wbb"),
  alpha = NULL,
  colour = NA,
  color = NULL,
  hjust = NULL,
  vjust = NULL,
  size = 0.5
)

element_sdv_headshot(
  sport = c("nfl", "nba", "wnba", "mlb", "nhl", "cfb", "mbb", "wbb"),
  alpha = NULL,
  colour = NA,
  color = NULL,
  hjust = NULL,
  vjust = NULL,
  size = 0.5,
  id_type = NULL
)

element_sdv_raster(
  image_path,
  x = grid::unit(0.5, "npc"),
  y = grid::unit(0.5, "npc"),
  width = grid::unit(1, "npc"),
  height = grid::unit(1, "npc"),
  just = "centre",
  hjust = 0.5,
  vjust = 0.5,
  interpolate = TRUE,
  ...
)

Arguments

sport

Character string identifying the sport. One of supported_sports().

alpha

The alpha channel (transparency) between 0 and 1.

colour, color

The image will be colorized with this color. Use "b/w" for black and white.

hjust

Horizontal justification.

vjust

Vertical justification.

size

The output grob size in cm.

id_type

Which ID system the player IDs hold: NULL (the default; GSIS IDs for the NFL, ESPN athlete IDs otherwise), "espn" or "league" (NBA / WNBA Stats PERSON_ID, MLBAM, NHL API, GSIS). See geom_sdv_headshots().

image_path

A file path or url to an image.

x, y, width, height, just, interpolate

Passed on to ggpath::element_raster().

...

Other arguments passed on to ggpath::element_raster().

Value

element_sdv_logo(), element_sdv_wordmark() and element_sdv_headshot() return an S3 object of class element; element_sdv_raster() returns a ggpath::element_raster().

Details

The elements translate team abbreviations or player IDs into logo images or player headshots for the specified sport. Rendering is delegated to ggpath::element_path().

See also

ggpath::element_path(), ggpath::element_raster()

Examples

# \donttest{
library(sdvplotR)
library(ggplot2)

team_abbr <- valid_team_names("nfl")[1:16]

df <- data.frame(
  random_value = runif(length(team_abbr), 0, 1),
  teams = team_abbr
)

# use logos for x-axis
ggplot(df, aes(x = teams, y = random_value)) +
  geom_col(aes(color = teams, fill = teams), width = 0.5) +
  scale_color_sdv(sport = "nfl", type = "secondary") +
  scale_fill_sdv(sport = "nfl", alpha = 0.4) +
  theme_minimal() +
  theme(axis.text.x = element_sdv_logo(sport = "nfl"))

# }