is_s3_generic
(Package: roxygen2) :
Determine if a function is an S3 generic or S3 method.
is_s3_generic compares name to .knownS3Generics and .S3PrimitiveGenerics, then looks at the function body to see if it calls UseMethod.
● Data Source:
CranContrib
● Keywords:
● Alias: is_s3_generic, is_s3_method
●
0 images
|
|
A 'Doxygen'-like in-source documentation system for Rd, collation, and 'NAMESPACE' files.
● Data Source:
CranContrib
● Keywords:
● Alias: roxygen2, roxygen2-package
●
0 images
|
new_roclet
(Package: roxygen2) :
Build new roclet object.
Build new roclet object.
● Data Source:
CranContrib
● Keywords: internal
● Alias: new_roclet
●
0 images
|
roc_proc_text
(Package: roxygen2) :
Process roclet on string and capture results.
Useful for testing.
● Data Source:
CranContrib
● Keywords: internal
● Alias: roc_proc_text
●
0 images
|
This rebuilds outdated vignettes with buildVignette(). By default, it will rebuild all vignettes if the source file is newer than the output pdf or html. (This means it will automatically re-build the vignette if you change the vignette source, but not when you change the R code). If you want finer control, add a Makefile to vignettes/ and roxygen2 will use that instead.
● Data Source:
CranContrib
● Keywords:
● Alias: vignette_roclet
●
0 images
|
rd_roclet
(Package: roxygen2) :
Roclet: make Rd files.
This roclet is the workhorse of roxygen, producing the Rd files that document that functions in your package.
● Data Source:
CranContrib
● Keywords:
● Alias: rd_roclet
●
0 images
|
|
This function is called to generate the default "Format" section for each data object. The default implementation will return the class and dimension information.
● Data Source:
CranContrib
● Keywords:
● Alias: default_data_format
●
0 images
|
source_package
(Package: roxygen2) :
Source all files in a package.
This is a simple attempt to load code in a package used by roxygenize. It will work with simple packages, but fail if there are compiled files, data files, etc. In that case, it's better to use document().
● Data Source:
CranContrib
● Keywords: internal
● Alias: source_package
●
0 images
|
update_collate
(Package: roxygen2) :
Update Collate field in DESCRIPTION.
Topologically sort R files and record in Collate field. The topological sort is based on the @include tag, which should specify the filenames (space separated) that should be loaded before the current file - these are typically necessary if you're using S4 or RC classes (because super classes must be defined before subclasses).
● Data Source:
CranContrib
● Keywords:
● Alias: update_collate
●
0 images
|
roxygenize
(Package: roxygen2) :
Process a package with the Rd, namespace and collate roclets.
This is the workhorse function that uses roclets, the built-in document tranformation functions, to build all documentation for a package. See the documentation for the individual roclets, rd_roclet, namespace_roclet, and for update_collate, for more details.
● Data Source:
CranContrib
● Keywords:
● Alias: roxygenise, roxygenize
●
0 images
|
providing 
.