R/produce_site_qrcode.R

In oggioniale/ReLTER: An Interface for the eLTER Community

#' Obtain the QRCode of any DEIMS-SDR entities.
#' @description `r lifecycle::badge("stable")`
#' Return a QR code image of any provided DEIMS ID (e.g. dataset,
#' site, activity).
#' @param deimsid A `character`. The DEIMS ID of entities from
#' DEIMS-SDR website. DEIMS ID information
#' \href{https://deims.org/docs/deimsid.html}{here}.
#' @param do_plot A `boolean`. Plot the computed QRCode. Default FALSE.
#' @return The QR code as a logical matrix with "qr_code" class.
#' @author Alessandro Oggioni, phD (2020) \email{oggioni.a@@irea.cnr.it}
#' @importFrom qrcode qr_code
#' @importFrom Rdpack reprompt
#' @references
#'   \insertRef{qrcodeR}{ReLTER}
#' @export
#' @examples
#' qrcode <- produce_site_qrcode(
#'   deimsid = "https://deims.org/f30007c4-8a6e-4f11-ab87-569db54638fe"
#' )
#' plot(qrcode)
#'
#' a <- produce_site_qrcode(
#'   deimsid = "https://deims.org/f30007c4-8a6e-4f11-ab87-569db54638fe",
#'   do_plot = TRUE
#' )
#'
#' @section The function output:
#' \figure{produce_site_qrcode_fig.png}{QRcode of Lake Maggiore site}
#'
### function produce_site_qrcode
produce_site_qrcode <- function(deimsid, do_plot = FALSE) {
  res <- qrcode::qr_code(deimsid, ecl = "L")
  if (do_plot) {
    a <- res %>%
      plot(col = c("White", "#1479BC"))
    a
  }
  return(res)
}