R/generate_LaTeX_manual.R

In HughParsonage/hutils: Miscellaneous R Functions and Aliases

#' Generate LaTeX manual of installed package
#' @param pkg Quoted package name (must be installed).
#' @param launch Should the PDF created be launched using the viewer (\code{TRUE} by default)?
#' @return See \code{\link[base]{system}}.
#' Called for its side-effect: creates a PDF in the current working directory. Requires a TeX distribution.
#' @source \url{https://stackoverflow.com/a/30608000/1664978}
#' @export

generate_LaTeX_manual <- function(pkg, launch = TRUE) {
  pack <- pkg
  path <- find.package(pack)
  system(paste(shQuote(file.path(R.home("bin"), "R")),
               "CMD", "Rd2pdf", "--batch", if (!launch) "--no-preview", shQuote(path)),
         show.output.on.console = FALSE)
}