get_hex: Get hex

In rworkflows: Test, Document, Containerise, and Deploy R Packages

Get hex

Description

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

Usage

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"))

rworkflows documentation built on Sept. 23, 2024, 1:08 a.m.