roxygen2: In-Source Documentation for R

Share:

A 'Doxygen'-like in-source documentation system for Rd, collation, and 'NAMESPACE' files.

Author
Hadley Wickham [aut, cre, cph], Peter Danenberg [aut, cph], Manuel Eugster [aut, cph], RStudio [cph]
Date of publication
2015-11-11 00:08:42
Maintainer
Hadley Wickham <hadley@rstudio.com>
License
GPL (>= 2)
Version
5.0.1
URLs

View on CRAN

Man pages

default_data_format
Default format for data
is_s3_generic
Determine if a function is an S3 generic or S3 method.
load_options
Load options from DESCRIPTION.
namespace_roclet
Roclet: make NAMESPACE.
new_roclet
Build new roclet object.
object
Constructors for S3 object to represent R objects.
rd_roclet
Roclet: make Rd files.
register-parser
Register tag parsers.
roc_proc_text
Process roclet on string and capture results.
roxygen2-package
In-Source Documentation for R
roxygenize
Process a package with the Rd, namespace and collate roclets.
source_package
Source all files in a package.
update_collate
Update Collate field in DESCRIPTION.
vignette_roclet
Re-build outdated vignettes.

Files in this package

roxygen2
roxygen2/inst
roxygen2/inst/doc
roxygen2/inst/doc/namespace.Rmd
roxygen2/inst/doc/rd.html
roxygen2/inst/doc/rdkeywords.R
roxygen2/inst/doc/collate.R
roxygen2/inst/doc/collate.html
roxygen2/inst/doc/formatting.html
roxygen2/inst/doc/rd.Rmd
roxygen2/inst/doc/namespace.R
roxygen2/inst/doc/formatting.R
roxygen2/inst/doc/collate.Rmd
roxygen2/inst/doc/namespace.html
roxygen2/inst/doc/rd.R
roxygen2/inst/doc/rdkeywords.Rmd
roxygen2/inst/doc/roxygen2.Rmd
roxygen2/inst/doc/formatting.Rmd
roxygen2/inst/doc/roxygen2.html
roxygen2/inst/doc/rdkeywords.html
roxygen2/inst/doc/roxygen2.R
roxygen2/tests
roxygen2/tests/testthat.R
roxygen2/tests/testthat
roxygen2/tests/testthat/test-utils.R
roxygen2/tests/testthat/roxygen-block-1.R
roxygen2/tests/testthat/test-rc.R
roxygen2/tests/testthat/empty
roxygen2/tests/testthat/empty/R
roxygen2/tests/testthat/empty/R/empty-package.R
roxygen2/tests/testthat/empty/DESCRIPTION
roxygen2/tests/testthat/test-tokenize-block.R
roxygen2/tests/testthat/test-reexport.R
roxygen2/tests/testthat/test-package-doc.R
roxygen2/tests/testthat/roxygen-block-2.R
roxygen2/tests/testthat/collate
roxygen2/tests/testthat/collate/watch.R
roxygen2/tests/testthat/collate/tie.R
roxygen2/tests/testthat/collate/jacket.R
roxygen2/tests/testthat/collate/shirt.R
roxygen2/tests/testthat/collate/belt.R
roxygen2/tests/testthat/collate/shoes.R
roxygen2/tests/testthat/collate/undershorts.R
roxygen2/tests/testthat/collate/socks.R
roxygen2/tests/testthat/collate/pants.R
roxygen2/tests/testthat/Rd-example-3.R
roxygen2/tests/testthat/test-slot.R
roxygen2/tests/testthat/test-data.R
roxygen2/tests/testthat/test-collate.R
roxygen2/tests/testthat/test-rdComplete.R
roxygen2/tests/testthat/test-introduction.R
roxygen2/tests/testthat/Rd-example-4.R
roxygen2/tests/testthat/test-preref.R
roxygen2/tests/testthat/test-examples.R
roxygen2/tests/testthat/man-roxygen
roxygen2/tests/testthat/man-roxygen/values.R
roxygen2/tests/testthat/man-roxygen/UCase.R
roxygen2/tests/testthat/man-roxygen/reg.ex.R
roxygen2/tests/testthat/man-roxygen/lcase.r
roxygen2/tests/testthat/test-rd.R
roxygen2/tests/testthat/roxygen-example-1.R
roxygen2/tests/testthat/made-by-roxygen
roxygen2/tests/testthat/made-by-roxygen/with-header.Rd
roxygen2/tests/testthat/made-by-roxygen/empty.Rd
roxygen2/tests/testthat/made-by-roxygen/without-header.Rd
roxygen2/tests/testthat/test-merge.R
roxygen2/tests/testthat/testCollateOverwrite
roxygen2/tests/testthat/testCollateOverwrite/R
roxygen2/tests/testthat/testCollateOverwrite/R/b.r
roxygen2/tests/testthat/testCollateOverwrite/R/a.r
roxygen2/tests/testthat/testCollateOverwrite/DESCRIPTION
roxygen2/tests/testthat/testLazyData
roxygen2/tests/testthat/testLazyData/NAMESPACE
roxygen2/tests/testthat/testLazyData/data
roxygen2/tests/testthat/testLazyData/data/a.rda
roxygen2/tests/testthat/testLazyData/R
roxygen2/tests/testthat/testLazyData/R/a.r
roxygen2/tests/testthat/testLazyData/DESCRIPTION
roxygen2/tests/testthat/testCollateNoIncludes
roxygen2/tests/testthat/testCollateNoIncludes/NAMESPACE
roxygen2/tests/testthat/testCollateNoIncludes/R
roxygen2/tests/testthat/testCollateNoIncludes/R/b.r
roxygen2/tests/testthat/testCollateNoIncludes/R/a.r
roxygen2/tests/testthat/testCollateNoIncludes/DESCRIPTION
roxygen2/tests/testthat/test-file-name.R
roxygen2/tests/testthat/test-describein.R
roxygen2/tests/testthat/helper-pkg.R
roxygen2/tests/testthat/test-wrapFieldIfNecessary.R
roxygen2/tests/testthat/test-inline.R
roxygen2/tests/testthat/test-raw.R
roxygen2/tests/testthat/test-field.R
roxygen2/tests/testthat/description-example_2.txt
roxygen2/tests/testthat/test-usage.R
roxygen2/tests/testthat/test-alias.R
roxygen2/tests/testthat/testEagerData
roxygen2/tests/testthat/testEagerData/data
roxygen2/tests/testthat/testEagerData/data/a.rda
roxygen2/tests/testthat/testEagerData/R
roxygen2/tests/testthat/testEagerData/R/a.r
roxygen2/tests/testthat/testEagerData/DESCRIPTION
roxygen2/tests/testthat/test-object.R
roxygen2/tests/testthat/test-doctype.R
roxygen2/tests/testthat/helper-env.R
roxygen2/tests/testthat/Rd-example-1.R
roxygen2/tests/testthat/test-format.R
roxygen2/tests/testthat/test-topic-name.R
roxygen2/tests/testthat/test-namespace.R
roxygen2/tests/testthat/test-keyword.R
roxygen2/tests/testthat/test-template.R
roxygen2/tests/testthat/Rd-example-5.R
roxygen2/tests/testthat/Rd-example-2.R
roxygen2/tests/testthat/test-family.R
roxygen2/tests/testthat/test-s3.R
roxygen2/tests/testthat/test-s4.R
roxygen2/tests/testthat/test-param.R
roxygen2/tests/testthat/test-srcref-comment.R
roxygen2/tests/testthat/description-example.txt
roxygen2/src
roxygen2/src/leadingSpaces.cpp
roxygen2/src/isComplete.cpp
roxygen2/src/parser2.cpp
roxygen2/src/wrapString.cpp
roxygen2/src/RcppExports.cpp
roxygen2/NAMESPACE
roxygen2/R
roxygen2/R/object-defaults.R
roxygen2/R/roxygen.R
roxygen2/R/utils.R
roxygen2/R/topo-sort.R
roxygen2/R/rd-tag-api.R
roxygen2/R/roclet-vignette.R
roxygen2/R/rd-file-api.R
roxygen2/R/family.R
roxygen2/R/roxygenize.R
roxygen2/R/inherit-params.R
roxygen2/R/topic-name.R
roxygen2/R/tag-registry.R
roxygen2/R/object-from-call.R
roxygen2/R/usage.R
roxygen2/R/roclet-namespace.R
roxygen2/R/object.R
roxygen2/R/safety.R
roxygen2/R/default-data-format.R
roxygen2/R/rd-parse.R
roxygen2/R/rd-escape.R
roxygen2/R/template.R
roxygen2/R/parse-preref.R
roxygen2/R/order-params.R
roxygen2/R/roxygen-tag.R
roxygen2/R/RcppExports.R
roxygen2/R/description.R
roxygen2/R/parse.R
roxygen2/R/roclet-collate.R
roxygen2/R/util-locale.R
roxygen2/R/minidesc.R
roxygen2/R/roclet-rd.R
roxygen2/R/source.R
roxygen2/R/roclet.R
roxygen2/R/s3.R
roxygen2/R/alias.R
roxygen2/R/rc.R
roxygen2/vignettes
roxygen2/vignettes/rdkeywords.md
roxygen2/vignettes/namespace.Rmd
roxygen2/vignettes/collate.md
roxygen2/vignettes/rd.md
roxygen2/vignettes/rd.Rmd
roxygen2/vignettes/formatting.md
roxygen2/vignettes/collate.Rmd
roxygen2/vignettes/roxygen2.md
roxygen2/vignettes/rdkeywords.Rmd
roxygen2/vignettes/roxygen2.Rmd
roxygen2/vignettes/formatting.Rmd
roxygen2/vignettes/namespace.md
roxygen2/README.md
roxygen2/MD5
roxygen2/build
roxygen2/build/vignette.rds
roxygen2/DESCRIPTION
roxygen2/man
roxygen2/man/is_s3_generic.Rd
roxygen2/man/roxygen2-package.Rd
roxygen2/man/new_roclet.Rd
roxygen2/man/roc_proc_text.Rd
roxygen2/man/vignette_roclet.Rd
roxygen2/man/rd_roclet.Rd
roxygen2/man/default_data_format.Rd
roxygen2/man/source_package.Rd
roxygen2/man/update_collate.Rd
roxygen2/man/roxygenize.Rd
roxygen2/man/object.Rd
roxygen2/man/namespace_roclet.Rd
roxygen2/man/register-parser.Rd
roxygen2/man/load_options.Rd