R/docFile.R

Defines functions docFile

Documented in docFile

#' Return the path to a documentation file in a package
#' 
#' Return the path to a documentation file in a package
#' 
#' @param file the name of a file
#' @param package the name of a package
#' @param character.only a logical. If `TRUE` package names must be
#' specified as character, else names will be converted as a convenience
#' as is [library()] and [library()].
#' @return a character vector specifying the path to the file on the user's system.
#' @export

docFile <- function(file, package="mosaic", character.only=FALSE) {
  if (! character.only)  package <- as.character(substitute(package))
  path <- find.package(package, verbose=FALSE)
  return(file.path(path,"doc",file))
}
ProjectMOSAIC/mosaic documentation built on Feb. 21, 2024, 2:11 a.m.