R/getgit.R

In cooltools: Practical Tools for Scientific Computation and Visualisation

#' Install a GitHub Package
#'
#' @importFrom pak pak
#' @importFrom gitcreds gitcreds_delete
#'
#' @description
#' Installs an R package from GitHub using \code{pak::pak()}.
#' If installation fails with GitHub HTTP error 401 / bad credentials, the
#' stored GitHub credentials are deleted using \code{gitcreds::gitcreds_delete()},
#' and the installation is attempted once more.
#'
#' @param reponame Character string. GitHub repository name in the form
#'   \code{"owner/repo"}, e.g. \code{"obreschkow/cooltools"}.
#' @param ... Additional arguments passed to \code{pak::pak()}.
#'
#' @return Invisibly returns the result of \code{pak::pak()}.
#'
#' @examples
#' \dontrun{
#' getgit("obreschkow/cooltools")
#' }
#'
#' @export
getgit = function(reponame, ...) {

  tryCatch(
    {
      invisible(pak::pak(reponame, ...))
    },
    error = function(e) {

      msg = conditionMessage(e)

      bad_credentials =
        grepl("HTTP error 401", msg, fixed = TRUE) ||
        grepl("Bad credentials", msg, fixed = TRUE)

      if (!bad_credentials) {
        stop(e)
      }

      message("GitHub bad credentials detected. Deleting stored git credentials and trying again...")

      gitcreds::gitcreds_delete()

      invisible(pak::pak(reponame, ...))
    }
  )
}