DocTypeTag-class: @docType: set the documentation type of the object.
In hadley/roxygen3: In-source documentation for R
Description
Roxygen3 will guess the doctype for you - the only time you should need to
specify it yourself for package documentation (@docType package)
which typically document the code NULL.
Details
You can use any doctype, but it will only be included in
the Rd file if it is one of the standard R doctypes: data, package,
methods and class.
Tag Usage
1
2
3
#' @docType data
#' @docType package
#' @docType custom doctype
hadley/roxygen3 documentation built on May 17, 2019, 12:16 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description
Roxygen3 will guess the doctype for you - the only time you should need to
specify it yourself for package documentation (@docType package)
which typically document the code NULL.
Details
You can use any doctype, but it will only be included in the Rd file if it is one of the standard R doctypes: data, package, methods and class.
Tag Usage
1 2 3 | #' @docType data
#' @docType package
#' @docType custom doctype
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.