roxygen2: In-Line Documentation for R

Generate your Rd documentation, 'NAMESPACE' file, and collation field using specially formatted comments. Writing documentation in-line with code makes it easier to keep your documentation up-to-date as your requirements change. 'Roxygen2' is inspired by the 'Doxygen' system for C++.

AuthorHadley Wickham [aut, cre, cph], Peter Danenberg [aut, cph], Manuel Eugster [aut, cph], RStudio [cph]
Date of publication2017-02-06 16:37:05
MaintainerHadley Wickham <hadley@rstudio.com>
LicenseGPL (>= 2)
Version6.0.1
https://github.com/klutometis/roxygen

View on CRAN

Functions

double_escape_md Man page
escape_rd_for_md Man page
export Man page
exportClass Man page
exportMethod Man page
import Man page
importClassesFrom Man page
importFrom Man page
importMethodsFrom Man page
is_s3_generic Man page
is_s3_method Man page
load_options Man page
markdown-test Man page
namespace_roclet Man page
object Man page
object_format Man page
rawNamespace Man page
rd_roclet Man page
roclet Man page
roclet Man page
roclet_clean Man page
roclet_find Man page
roclet_output Man page
roclet_process Man page
roclet_tags Man page
roc_proc_text Man page
roxygen2 Man page
roxygen2-package Man page
roxygenise Man page
roxygenize Man page
roxy_tag Man page
roxy_tag_warning Man page
S3method Man page
source_package Man page
tag_code Man page
tag_examples Man page
tag_inherit Man page
tag_markdown Man page
tag_markdown_restricted Man page
tag_name Man page
tag_name_description Man page
tag_toggle Man page
tag_two_part Man page
tag_value Man page
tag_words Man page
tag_words_line Man page
unescape_rd_for_md Man page
update_collate Man page
useDynLib Man page
vignette_roclet Man page

Files

roxygen2
roxygen2/inst
roxygen2/inst/doc
roxygen2/inst/doc/markdown.R
roxygen2/inst/doc/namespace.Rmd
roxygen2/inst/doc/rd.html
roxygen2/inst/doc/markdown.html
roxygen2/inst/doc/rdkeywords.R
roxygen2/inst/doc/collate.R
roxygen2/inst/doc/collate.html
roxygen2/inst/doc/formatting.html
roxygen2/inst/doc/markdown.Rmd
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-object-s3.R
roxygen2/tests/testthat/test-rd-field.R
roxygen2/tests/testthat/test-utils.R
roxygen2/tests/testthat/roxygen-block-1.R
roxygen2/tests/testthat/test-rd-raw.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-reexport.R
roxygen2/tests/testthat/roxygen-block-2.R
roxygen2/tests/testthat/testNonASCII
roxygen2/tests/testthat/testNonASCII/R
roxygen2/tests/testthat/testNonASCII/R/a.r
roxygen2/tests/testthat/testNonASCII/DESCRIPTION
roxygen2/tests/testthat/test-rd-name.R
roxygen2/tests/testthat/test-rd-alias.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-rd-examples.R
roxygen2/tests/testthat/testRbuildignore
roxygen2/tests/testthat/testRbuildignore/R
roxygen2/tests/testthat/testRbuildignore/R/a.R
roxygen2/tests/testthat/testRbuildignore/R/ignore_me.R
roxygen2/tests/testthat/testRbuildignore/DESCRIPTION
roxygen2/tests/testthat/test-collate.R
roxygen2/tests/testthat/test-rd-slot.R
roxygen2/tests/testthat/test-rdComplete.R
roxygen2/tests/testthat/test-Rd-inherit.R
roxygen2/tests/testthat/Rd-example-4.R
roxygen2/tests/testthat/test-rd-template.R
roxygen2/tests/testthat/test-rd-section.R
roxygen2/tests/testthat/test-rd-describein.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/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-select_args.R
roxygen2/tests/testthat/test-rd-markdown-links.R
roxygen2/tests/testthat/test-rd-doctype.R
roxygen2/tests/testthat/helper-pkg.R
roxygen2/tests/testthat/test-rd-family.R
roxygen2/tests/testthat/test-object-s4.R
roxygen2/tests/testthat/test-rd-param.R
roxygen2/tests/testthat/test-parse.R
roxygen2/tests/testthat/description-example_2.txt
roxygen2/tests/testthat/test-nonASCII.R
roxygen2/tests/testthat/helper-test.R
roxygen2/tests/testthat/test-rd-markdown-on-off.R
roxygen2/tests/testthat/test-rd-keyword.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-rd-markdown-escaping.R
roxygen2/tests/testthat/test-object.R
roxygen2/tests/testthat/test-rd-introduction.R
roxygen2/tests/testthat/test-Rbuildignore.R
roxygen2/tests/testthat/test-rd-backref.R
roxygen2/tests/testthat/test-object-rc.R
roxygen2/tests/testthat/test-rd-data.R
roxygen2/tests/testthat/test-rd-markdown.R
roxygen2/tests/testthat/helper-env.R
roxygen2/tests/testthat/Rd-example-1.R
roxygen2/tests/testthat/test-parse-block.R
roxygen2/tests/testthat/test-topic.R
roxygen2/tests/testthat/test-namespace.R
roxygen2/tests/testthat/Rd-example-5.R
roxygen2/tests/testthat/Rd-example-2.R
roxygen2/tests/testthat/test-rd-package.R
roxygen2/tests/testthat/test-nice-name.R
roxygen2/tests/testthat/test-object-format.R
roxygen2/tests/testthat/test-rd-usage.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/NEWS.md
roxygen2/R
roxygen2/R/rd-describe-in.R roxygen2/R/object-defaults.R roxygen2/R/utils-rd.R roxygen2/R/roxygen.R roxygen2/R/utils.R roxygen2/R/topo-sort.R roxygen2/R/tag.R roxygen2/R/topic.R roxygen2/R/markdown.R roxygen2/R/rd-family.R roxygen2/R/enc.R roxygen2/R/object-rc.R roxygen2/R/roxygenize.R roxygen2/R/collate.R roxygen2/R/object-from-call.R roxygen2/R/field.R roxygen2/R/rd-params.R roxygen2/R/object-usage.R roxygen2/R/namespace.R roxygen2/R/object.R roxygen2/R/safety.R roxygen2/R/rd-template.R roxygen2/R/rd-inherit.R roxygen2/R/markdown-escaping.R roxygen2/R/RcppExports.R roxygen2/R/rd.R roxygen2/R/object-s3.R roxygen2/R/parse.R roxygen2/R/select-args.R roxygen2/R/object-name.R roxygen2/R/util-locale.R roxygen2/R/source.R roxygen2/R/vignette.R roxygen2/R/roclet.R roxygen2/R/object-format.R roxygen2/R/topics.R roxygen2/R/object-package.R
roxygen2/vignettes
roxygen2/vignettes/rdkeywords.md
roxygen2/vignettes/namespace.Rmd
roxygen2/vignettes/releases
roxygen2/vignettes/releases/roxygen2-6.0.0.Rmd
roxygen2/vignettes/collate.md
roxygen2/vignettes/markdown.Rmd
roxygen2/vignettes/rd.md
roxygen2/vignettes/rd.Rmd
roxygen2/vignettes/formatting.md
roxygen2/vignettes/collate.Rmd
roxygen2/vignettes/markdown.md
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/double_escape_md.Rd roxygen2/man/is_s3_generic.Rd roxygen2/man/roxygen2-package.Rd roxygen2/man/roc_proc_text.Rd roxygen2/man/vignette_roclet.Rd roxygen2/man/markdown-test.Rd roxygen2/man/roclet.Rd roxygen2/man/rd_roclet.Rd roxygen2/man/source_package.Rd roxygen2/man/update_collate.Rd roxygen2/man/object_format.Rd roxygen2/man/markdown-internals.Rd roxygen2/man/roxygenize.Rd roxygen2/man/object.Rd roxygen2/man/namespace_roclet.Rd roxygen2/man/load_options.Rd roxygen2/man/roclet_find.Rd roxygen2/man/roxy_tag.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.