R/open_guide.R

Defines functions open_guide

Documented in open_guide

#' Open UserGuide of the package
#'
#' @param ext extension of the book to open: 'html', 'pdf'
#'
#' @importFrom utils browseURL
#'
#' @export
open_guide <- function(ext = "html") {
    if (ext == "html") {
    guide_path <- system.file('report/_book/index.html', package = 'darthpack')
    } else if (ext == "pdf") {
    guide_path <- system.file('report/_book/report.pdf', package = 'darthpack')
    } else {
    guide_path <- system.file(paste0("report/_book/report.", ext[1]), package = 'darthpack')
    }

  browseURL(paste0('file:/', guide_path))
}
DARTH-git/darthpack documentation built on March 10, 2024, 3:31 p.m.