R/prism_shape_pal.R

In csdaw/ggprism: A 'ggplot2' Extension Inspired by 'GraphPad Prism'

#' Prism shape palettes
#'
#' Shape palettes that approximate those used in GraphPad Prism.
#' No unicode characters are used, only the default symbols available in R.
#'
#' The `default` palette supports up to 9 values. It does not use
#' any symbols with a fill.
#'
#' The `filled` palette supports up to 10 values. The first 5 symbols
#' have a fill.
#'
#' The `complete` palette supports up to 14 values. Symbols 5 to 9
#' have a fill.
#'
#' @inheritParams scale_shape_prism
#' @return Returns a function which takes a single integer as its only argument
#' and returns a character vector of integers which correspond to R plot pch
#' symbols.
#' See the examples below for usage.
#' @example inst/examples/ex-prism_shape_pal.R
#' @export
prism_shape_pal <- function(palette = c("default", "filled", "complete")) {
  palette <- match.arg(palette)
  shapes <- ggprism::ggprism_data$shape_palettes[[palette]]

  out <- manual_pal(shapes[["pch"]])
  attr(out, "max_n") <- nrow(shapes)
  out
}