R/health_icons.R

In icons: Easily Insert SVG Icons into R Outputs

#' @rdname health_icons
#' @export
download_health_icons <- function(){
  url <- "https://healthicons.org/icons.zip"

  meta <- jsonlite::read_json(
    "https://raw.githubusercontent.com/resolvetosavelives/healthicons/main/package.json"
  )

  install_icon_zip(
    "health_icons", url, function(dl_dir) file.path(dl_dir, "icons", "svg"),
    meta = list(
      name = "Health Icons",
      version = meta$version,
      licence = c("CC-0", "MIT")
    )
  )

  invisible(health_icons)
}

#' Health icons
#'
#' @param name Name of the icon
#' @param category The icon's category, either "blood", "body", "conditions",
#'   "devices", "diagnostics", "emotions", "family", "medications", "objects",
#'   "people", "places", "shapes", "specialties", "symbols", "typography", or
#'   "vehicles"
#' @param theme The style variant for the icon, requires v4.0.0 or greater.
#'   Available themes vary by icon, but can be either "filled", "negative",
#'   "outline". If NULL, it will default to the
#'   first available variant in this order.
#'
#' @section License:
#' Health Icons are released into the public domain under the
#' [CC0 1.0 Universal License](https://creativecommons.org/publicdomain/zero/1.0/);
#' no attribution is required. The Health Icons codebase itself is licensed
#' separately under the [MIT License](https://github.com/resolvetosavelives/healthicons/blob/main/LICENSE).
#'
#' @return `download_health_icons()` invisibly returns the `health_icons`
#'   icon set after downloading and installing its SVG files locally.
#'
#'   `health_icons(name, category, theme)` returns an `icons` vector (an
#'   SVG tag) for the requested icon.
#'
#' @rdname health_icons
#' @export
health_icons <- new_icon_set(
  "health_icons",
  function(name, category = NULL, theme = NULL){
    if(is.null(category)){
      icon_guess(name, "health_icons", pattern = theme)
    } else {
      icon_fn$get(c(theme, category, name))
    }
  }
)