R/get_manual.R

In neotoma2: Working with the Neotoma Paleoecology Database

#' @title get_manual
#' @author Simon Goring \email{goring@@wisc.edu}
#' @description Open up the Neotoma manual homepage.
#' @examples {
#' # This call does not work from `source()` calls or in testing.
#' # interactive() just lets us know you are interacting with the console:
#' if (interactive()) {
#'  get_manual()
#' }
#' }
#' 
#' @importFrom utils browseURL
#' @importFrom rlang is_interactive
#' @returns NULL side effect for opening browser with the manual
#' @export
get_manual <- function() {
  if (rlang::is_interactive()) {
    browseURL(url = "https://open.neotomadb.org/manual/")
  } else {
    stop("Browser window will not open if interactive() mode is FALSE.")
  }
  return(NULL)
}