In-Line Documentation for R


[Up] [Top]

Documentation for package ‘roxygen2’ version 6.1.1

Help Pages

roxygen2-package roxygen2: In-Line Documentation for R
double_escape_md Escape % and \$ and \_ once more, because commonmark removes the escaping. We do this everywhere currently.
evalNamespace Roclet: make NAMESPACE.
export Roclet: make NAMESPACE.
exportClass Roclet: make NAMESPACE.
exportMethod Roclet: make NAMESPACE.
exportPattern Roclet: make NAMESPACE.
import Roclet: make NAMESPACE.
importClassesFrom Roclet: make NAMESPACE.
importFrom Roclet: make NAMESPACE.
importMethodsFrom Roclet: make NAMESPACE.
is_s3_generic Determine if a function is an S3 generic or S3 method.
is_s3_method Determine if a function is an S3 generic or S3 method.
namespace_roclet Roclet: make NAMESPACE.
object_format Default format for data
rawNamespace Roclet: make NAMESPACE.
rd_roclet Roclet: make Rd files.
roclet_find Create a roclet from a string.
roxygen2 roxygen2: In-Line Documentation for R
roxygenise Process a package with the Rd, namespace and collate roclets.
roxygenize Process a package with the Rd, namespace and collate roclets.
S3method Roclet: make NAMESPACE.
update_collate Update Collate field in DESCRIPTION.
useDynLib Roclet: make NAMESPACE.
vignette_roclet Re-build outdated vignettes.