R/meta-open_pkgdown.R

Defines functions open_pkgdown

Documented in open_pkgdown

#' Open pkgdown site of the package
#'
#' @importFrom utils browseURL
#'
#' @export
#'
#' @examples
#' # open_pkgdown()
open_pkgdown <- function() {
  guide_path <- system.file("docs/index.html", package = "lossrx")
  if (guide_path == "") {
    stop("There is no pkgdown site in ", "docs/index.html")
  }

  browseURL(paste0("file://", guide_path))
}
jimbrig/lossrx documentation built on Dec. 20, 2024, 3:46 a.m.