1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/document.R 3\name{document} 4\alias{document} 5\title{Use roxygen to document a package.} 6\usage{ 7document(pkg = ".", roclets = NULL, quiet = FALSE) 8} 9\arguments{ 10\item{pkg}{The package to use, can be a file path to the package or a 11package object. See \code{\link[=as.package]{as.package()}} for more information.} 12 13\item{roclets}{Character vector of roclet names to use with package. 14The default, \code{NULL}, uses the roxygen \code{roclets} option, 15which defaults to \code{c("collate", "namespace", "rd")}.} 16 17\item{quiet}{if \code{TRUE} suppresses output from this function.} 18} 19\description{ 20This function is a wrapper for the \code{\link[roxygen2:roxygenize]{roxygen2::roxygenize()}} 21function from the roxygen2 package. See the documentation and vignettes of 22that package to learn how to use roxygen. 23} 24\seealso{ 25\code{\link[roxygen2:roxygenize]{roxygen2::roxygenize()}}, 26\code{browseVignettes("roxygen2")} 27} 28