R/utils.R

In msperlin/vdr: Data and Functions for Book Visualizacao de Dados com o R

#' Formats versions for plots (used in cowplot::plot_grid())
#'
#' @param n_plots number of plots
#'
#' @return a string
#' @export
#'
#' @examples
#' versions_string(10)
versions_string <- function(n_plots) {

  str_out <- sprintf("v%02.f", 1:n_plots)

  return(str_out)
}

#' Returns local dir of pkg
#'
#' @param sub_dir the sub dir to return path
#'
#' @return a path
#' @export
#'
#' @examples
#' get_pkg_dir("eoce")
get_pkg_dir <- function(sub_dir) {
  my_dir <- fs::path(
    system.file("extdata", package = "vdr"),
    sub_dir)

  if (!fs::dir_exists(my_dir)) {
    cli::cli_abort("Cant find dir {my_dir}")
  }

  return(my_dir)
}

#' Returns local dir of pkg
#'
#' @param img_file name of img file
#'
#' @return a path
#' @export
#'
#' @examples
#' exercises_get_img("exercises-reddit-brazil.jpg")
exercises_get_img <- function(img_file) {

  vdr_eoc_html <- Sys.getenv("vdr_eoc_html")

  if (vdr_eoc_html == "") { # local compilation

    this_path <- fs::path(
      get_pkg_dir("img-exercises"),
      img_file
    )

    if (!fs::file_exists(this_path)) {
      cli::cli_abort("cant find file {this_path}")
    }

  } else {
    this_path <- fs::path(
      "00b-text-resources/figs/",
      img_file
    )

  }

  # my_url <- fs::path(
  #   #"00b-text-resources/figs/",
  #   "https://www.msperlin.com/vdr/00b-text-resources/figs/",
  #   img_file
  # )
  #
  # if (!check_link(my_url)) {
  #   #cli::cli_abort("link {my_url} not working")
  # }


  return(this_path)
}

#' Prints imgs in exercises
#'
#' @param img_file name of img file
#' @param this_caption caption of img
#'
#' @return nothing
#' @export
#'
#' @examples
#' exercises_print_img("exercises-latinometrics-instagram_01-SOLUTION-20220927.png", "NONE")
exercises_print_img <- function(img_file, this_caption) {
  my_f <- exercises_get_img(img_file)

  cat(stringr::str_glue(
      "![{this_caption}]({my_f })"
    )
  )
  return(invisible(TRUE))
}

#' Check if link exists
#'
#' @noRd
check_link <- function(link_in) {

  #cli::cli_alert_info("Checking {link_in}")

  out_get <- list()

  try({
    out_get <- httr::GET(link_in)
  })

  status_code <- out_get$status_code

  flag <- status_code == 200

  return(invisible(flag))
}