Get hex — get_hex • rworkflows

Get the URL of a hex sticker for a given R package (if one exists).

get_hex(
  refs = NULL,
  paths = here::here("DESCRIPTION"),
  hex_path = "inst/hex/hex.png",
  branch = c("master", "main", "dev"),
  hex_height = 300,
  check_url = TRUE,
  add_html = TRUE,
  verbose = TRUE
)

Arguments

refs: Reference for one or more GitHub repository in owner/repo format (e.g."neurogenomics/rworkflows"), or an R package name (e.g. "rworkflows").
paths: Paths to DESCRIPTION file(s) R package(s).
hex_path: Path to hex sticker file.
branch: Name of the GitHub repository branch to use.
hex_height: Height of the hex sticker in pixels (when add_hex=TRUE).
check_url: Check whether the URL actually exists.
add_html: Wrap the URL in an html "img" tag and set its height with hex_height.
verbose: Print messages.

Value

URL

Examples

hex_url <- get_hex(refs=c("neurogenomics/rworkflows",
                          "neurogenomics/echolocatoR"))
#> When refs is provided, paths must have the same length (or be set to NULL). Setting paths=NULL.
#> Cannot find DESCRIPTION for: echolocatoR
#> Cannot find DESCRIPTION file for: neurogenomics/echolocatoR
#> Finding hex sticker(s) for 2 package(s).
#> Hex URL does not exist (or is not public). Returning NULL.