R.ignore/hex-logo.R

In villegar/trainR: An Interface to the National Rail Enquiries Systems

#' Create hexagonal logo for the package
#'
#' @param subplot image to use as the main logo
#' @param dpi plot resolution (dots-per-inch)
#' @param h_color colour for hexagon border
#' @param h_fill colour to fill hexagon
#' @param output output file (hexagonal logo)
#' @param package title for logo (package name)
#' @param p_color colour for package name
#' @param url URL for package repository or website
#' @param u_size text size for URL
#'
#' @return hexagonal logo
#' @noRd
#' @keywords internal
#'
#' @examples
#' \dontrun{
#'     hex_logo()
#'     hex_logo("inst/images/train.png",
#'              output = "inst/images/logo3.png")
#' }
hex_logo <- function(subplot = system.file("images/train.png",
                                           package = "trainR"),
                     dpi = 600,
                     h_color = "#000000",
                     h_fill = "#effcdf",
                     output = system.file("images/logo.png",
                                          package = "trainR"),
                     package = "trainR",
                     p_color = "#000000",
                     url = "https://github.com/villegar/trainR",
                     u_size = 1.5) {
  hexSticker::sticker(subplot = subplot, package = package,
                      h_color = h_color,  h_fill = h_fill,
                      dpi = dpi,
                      s_x = 1.0, s_y = .9, s_width = .65, asp = 0.8,
                      p_x = 1.0, p_y = 1.62, p_size = 6, p_color = p_color,
                      url = url,
                      u_angle = 30, u_color = p_color, u_size = u_size,
                      filename = output)
}
hex_logo("inst/images/train.png", output = "inst/images/logo.png")