R/meta-open_docs.R

In jimbrig/jimstools: Tools for R

#' Open local version of pkgdown site for `jimstools`
#'
#' @importFrom utils browseURL
#'
#' @export
open_docs <- function() {

  guide_path <- system.file('docs/index.html', package = 'jimstools')

  if (guide_path == "") {
    stop('There is no pkgdown site in ', 'docs/index.html')
  }

  browseURL(paste0('file://', guide_path))

}