roxygen2: In-Line Documentation for R
Version 6.0.1

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
URL https://github.com/klutometis/roxygen
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("roxygen2")

Getting started

Package overview
README.md
Collation order
Generating Rd files
Introduction to roxygen2
Package namespace
Rd keywords
Text formatting reference sheet
Write R Documentation in Markdown

Popular man pages

markdown-internals: Escape Rd markup, to avoid interpreting it as markdown
markdown-test: Dummy page to test roxygen's markdown formatting
roclet_find: Create a roclet from a string.
roc_proc_text: Process roclet on string and capture results.
roxygen2-package: roxygen2: In-Line Documentation for R
roxygenize: Process a package with the Rd, namespace and collate roclets.
roxy_tag: Parsing tags.
See all...

All man pages Function index File listing

Man pages

double_escape_md: Escape % and \$ and \_ once more, because commonmark removes...
is_s3_generic: Determine if a function is an S3 generic or S3 method.
load_options: Load options from DESCRIPTION.
markdown-internals: Escape Rd markup, to avoid interpreting it as markdown
markdown-test: Dummy page to test roxygen's markdown formatting
namespace_roclet: Roclet: make NAMESPACE.
object: Constructors for S3 object to represent R objects.
object_format: Default format for data
rd_roclet: Roclet: make Rd files.
roclet: Build a new roclet.
roclet_find: Create a roclet from a string.
roc_proc_text: Process roclet on string and capture results.
roxygen2-package: roxygen2: In-Line Documentation for R
roxygenize: Process a package with the Rd, namespace and collate roclets.
roxy_tag: Parsing tags.
source_package: Source all files in a package.
update_collate: Update Collate field in DESCRIPTION.
vignette_roclet: Re-build outdated vignettes.

Functions

S3method Man page
add_defaults Source code
add_linkrefs_to_md Source code
add_made_by_roxygen Source code
add_rc_metadata Source code
add_s3_metadata Source code
args_string Source code
author_desc Source code
author_type Source code
base_path Source code
block_tags Source code
block_to_ns Source code
block_to_rd Source code
block_warning Source code
build_label Source code
build_rd Source code
c.rd Source code
calls_use_method Source code
check_made_by Source code
check_topic Source code
collapse Source code
comments Source code
compact Source code
contains_once Source code
default_export Source code
default_export.NULL Source code
default_export.default Source code
default_export.rcclass Source code
default_export.s3method Source code
default_export.s4class Source code
default_export.s4generic Source code
default_export.s4method Source code
default_tags Source code
describe_section Source code
docstring Source code
dots Source code
double_escape_md Man page Source code
env_namespace Source code
escape Source code
escape.character Source code
escape.rd Source code
escape_examples Source code
escape_rd_for_md Man page Source code
export Man page Source code
exportClass Man page
exportMethod Man page
export_class Source code
export_s3_method Source code
export_s4_method Source code
extract_method_fun Source code
findEndOfTag Source code
find_all_rd_tags Source code
find_all_tag_names Source code
find_data Source code
find_data_for_package Source code
find_field Source code
find_fragile_rd_tags Source code
find_generic Source code
find_includes Source code
find_object Source code
find_params Source code
find_parser Source code
find_sections Source code
find_topic Source code
first_time Source code
format.roxy_field Source code
format.roxy_field_alias Source code
format.roxy_field_backref Source code
format.roxy_field_examples Source code
format.roxy_field_field Source code
format.roxy_field_minidesc Source code
format.roxy_field_name Source code
format.roxy_field_param Source code
format.roxy_field_rawRd Source code
format.roxy_field_rcmethods Source code
format.roxy_field_reexport Source code
format.roxy_field_section Source code
format.roxy_field_slot Source code
format.roxy_field_usage Source code
format_classes Source code
format_collapse Source code
format_dim Source code
format_first Source code
format_null Source code
format_rd Source code
full_markdown Source code
fun_args Source code
function_usage Source code
generate_collate Source code
get_documented_params Source code
get_method Source code
get_rd Source code
get_tag Source code
get_tags Source code
has.quotes Source code
has_colons Source code
ignore_files Source code
import Man page
importClassesFrom Man page
importFrom Man page
importMethodsFrom Man page
inherit_dot_params Source code
inherit_field Source code
inherit_params Source code
inherit_section Source code
inherit_sections Source code
internal_f Source code
invert Source code
is.roclet Source code
is.roxy_tag Source code
is.s3 Source code
is.s3generic Source code
is.s3method Source code
is.syntactic Source code
is_empty_xml Source code
is_generator Source code
is_infix_fun Source code
is_replacement_fun Source code
is_roxy_field Source code
is_s3_generic Man page Source code
is_s3_method Man page Source code
itemize Source code
leadingSpaces Source code
load_options Man page Source code
load_pkg_dependencies Source code
loaded_package Source code
made_by Source code
made_by_roxygen Source code
make_random_string Source code
make_tag_message Source code
markdown Source code
markdown-test Man page
markdown_on Source code
markdown_rparse Source code
merge.roxy_field Source code
merge.roxy_field_inherit Source code
merge.roxy_field_inherit_dot_params Source code
merge.roxy_field_inherit_section Source code
merge.roxy_field_minidesc Source code
merge.roxy_field_reexport Source code
merge.roxy_field_section Source code
move_names_to_front Source code
mtime Source code
namespace_roclet Man page Source code
needs_doc Source code
nice_name Source code
ns_S3method Source code
ns_export Source code
ns_exportClass Source code
ns_exportMethod Source code
ns_exportPattern Source code
ns_import Source code
ns_importClassesFrom Source code
ns_importFrom Source code
ns_importMethodsFrom Source code
ns_process_tag Source code
ns_rawNamespace Source code
ns_useDynLib Source code
obj_type Source code
obj_type.MethodDefinition Source code
obj_type.classRepresentation Source code
obj_type.default Source code
obj_type.genericFunction Source code
obj_type.package Source code
obj_type.refClassRepresentation Source code
obj_type.refMethodDef Source code
obj_type.s3generic Source code
obj_type.s3method Source code
object Man page Source code
object_defaults Source code
object_defaults.data Source code
object_defaults.default Source code
object_defaults.import Source code
object_defaults.package Source code
object_defaults.rcclass Source code
object_defaults.s4class Source code
object_defaults.s4method Source code
object_format Man page Source code
object_format.default Source code
object_from_call Source code
object_name Source code
object_name.default Source code
object_name.function Source code
object_name.rcclass Source code
object_name.rcmethod Source code
object_name.s3generic Source code
object_name.s3method Source code
object_name.s4class Source code
object_name.s4generic Source code
object_name.s4method Source code
object_topic Source code
object_topic.default Source code
object_topic.rcclass Source code
object_topic.rcmethod Source code
object_topic.s4class Source code
object_topic.s4method Source code
object_usage Source code
object_usage.NULL Source code
object_usage.data Source code
object_usage.default Source code
object_usage.function Source code
object_usage.rcclass Source code
object_usage.s3method Source code
object_usage.s4class Source code
object_usage.s4generic Source code
object_usage.s4method Source code
one_per_line Source code
package_authors Source code
package_files Source code
package_seealso Source code
package_suffix Source code
parse_block Source code
parse_blocks Source code
parse_description Source code
parse_link Source code
parse_package Source code
parse_tag Source code
parse_text Source code
parser_assignment Source code
parser_setClass Source code
parser_setClassUnion Source code
parser_setConstructorS3 Source code
parser_setGeneric Source code
parser_setMethod Source code
parser_setMethodS3 Source code
parser_setRefClass Source code
parser_setReplaceMethod Source code
print.object Source code
print.rd Source code
print.roxy_field Source code
print.roxy_tag Source code
process_def_tag Source code
process_tag Source code
process_templates Source code
protect_rd_tags Source code
quote_if_needed Source code
r_files Source code
rawNamespace Man page
rc_methods Source code
rd Source code
rd2text Source code
rdComplete Source code
rd_macro Source code
rd_roclet Man page Source code
read.description Source code
read_lines_enc Source code
read_pkg_description Source code
repeat_first Source code
restricted_markdown Source code
roc_proc_text Man page Source code
roclet Man page Man page Source code
roclet_clean Man page Source code
roclet_clean.roclet_namespace Source code
roclet_clean.roclet_rd Source code
roclet_find Man page Source code
roclet_output Man page Source code
roclet_output.roclet_namespace Source code
roclet_output.roclet_rd Source code
roclet_output.roclet_vignette Source code
roclet_process Man page Source code
roclet_process.roclet_namespace Source code
roclet_process.roclet_rd Source code
roclet_process.roclet_vignette Source code
roclet_tags Man page Source code
roclet_tags.roclet_namespace Source code
roclet_tags.roclet_rd Source code
roclet_tags.roclet_vignette Source code
roxy_field Source code
roxy_field_inherit Source code
roxy_field_inherit_dot_params Source code
roxy_field_inherit_section Source code
roxy_field_minidesc Source code
roxy_field_reexport Source code
roxy_field_section Source code
roxy_field_simple Source code
roxy_tag Man page Source code
roxy_tag_warning Man page Source code
roxygen2 Man page
roxygen2-package Man page
roxygenise Man page
roxygenize Man page Source code
s3_method Source code
s3_method_info Source code
same_contents Source code
select_args Source code
select_args_text Source code
select_check Source code
select_sign Source code
set_collate Source code
sort_c Source code
source_package Man page Source code
splitByWhitespace Source code
srcref_location Source code
standardise_call Source code
standardise_obj Source code
str_sub_same Source code
strip Source code
sys_source Source code
tag_code Man page Source code
tag_examples Man page Source code
tag_inherit Man page Source code
tag_markdown Man page Source code
tag_markdown_restricted Man page Source code
tag_name Man page Source code
tag_name_description Man page
tag_toggle Man page Source code
tag_two_part Man page Source code
tag_value Man page Source code
tag_words Man page Source code
tag_words_line Man page Source code
template_eval Source code
template_find Source code
tokenise_block Source code
topic_add_backref Source code
topic_add_describe_in Source code
topic_add_doc_type Source code
topic_add_eval_rd Source code
topic_add_examples Source code
topic_add_fields Source code
topic_add_inherit Source code
topic_add_keyword Source code
topic_add_methods Source code
topic_add_name_aliases Source code
topic_add_params Source code
topic_add_sections Source code
topic_add_simple_tags Source code
topic_add_slots Source code
topic_add_usage Source code
topic_add_value Source code
topic_params Source code
topic_params.Rd Source code
topic_params.RoxyTopic Source code
topics_fix_params_order Source code
topics_process_family Source code
topics_process_inherit Source code
trim_docstring Source code
unescape_rd_for_md Man page Source code
update_collate Man page Source code
update_roxygen_version Source code
usage_args Source code
useDynLib Man page
vign_outdated Source code
vign_update Source code
vign_update_all Source code
vignette_roclet Man page Source code
with_collate Source code
wrapString Source code
wrap_string Source code
wrap_string.NULL Source code
wrap_string.default Source code
write_if_different Source code
ws_to_empty Source code

Files

inst
inst/doc
inst/doc/markdown.R
inst/doc/namespace.Rmd
inst/doc/rd.html
inst/doc/markdown.html
inst/doc/rdkeywords.R
inst/doc/collate.R
inst/doc/collate.html
inst/doc/formatting.html
inst/doc/markdown.Rmd
inst/doc/rd.Rmd
inst/doc/namespace.R
inst/doc/formatting.R
inst/doc/collate.Rmd
inst/doc/namespace.html
inst/doc/rd.R
inst/doc/rdkeywords.Rmd
inst/doc/roxygen2.Rmd
inst/doc/formatting.Rmd
inst/doc/roxygen2.html
inst/doc/rdkeywords.html
inst/doc/roxygen2.R
tests
tests/testthat.R
tests/testthat
tests/testthat/test-object-s3.R
tests/testthat/test-rd-field.R
tests/testthat/test-utils.R
tests/testthat/roxygen-block-1.R
tests/testthat/test-rd-raw.R
tests/testthat/empty
tests/testthat/empty/R
tests/testthat/empty/R/empty-package.R
tests/testthat/empty/DESCRIPTION
tests/testthat/test-reexport.R
tests/testthat/roxygen-block-2.R
tests/testthat/testNonASCII
tests/testthat/testNonASCII/R
tests/testthat/testNonASCII/R/a.r
tests/testthat/testNonASCII/DESCRIPTION
tests/testthat/test-rd-name.R
tests/testthat/test-rd-alias.R
tests/testthat/collate
tests/testthat/collate/watch.R
tests/testthat/collate/tie.R
tests/testthat/collate/jacket.R
tests/testthat/collate/shirt.R
tests/testthat/collate/belt.R
tests/testthat/collate/shoes.R
tests/testthat/collate/undershorts.R
tests/testthat/collate/socks.R
tests/testthat/collate/pants.R
tests/testthat/Rd-example-3.R
tests/testthat/test-rd-examples.R
tests/testthat/testRbuildignore
tests/testthat/testRbuildignore/R
tests/testthat/testRbuildignore/R/a.R
tests/testthat/testRbuildignore/R/ignore_me.R
tests/testthat/testRbuildignore/DESCRIPTION
tests/testthat/test-collate.R
tests/testthat/test-rd-slot.R
tests/testthat/test-rdComplete.R
tests/testthat/test-Rd-inherit.R
tests/testthat/Rd-example-4.R
tests/testthat/test-rd-template.R
tests/testthat/test-rd-section.R
tests/testthat/test-rd-describein.R
tests/testthat/man-roxygen
tests/testthat/man-roxygen/values.R
tests/testthat/man-roxygen/UCase.R
tests/testthat/man-roxygen/reg.ex.R
tests/testthat/man-roxygen/lcase.r
tests/testthat/test-rd.R
tests/testthat/roxygen-example-1.R
tests/testthat/made-by-roxygen
tests/testthat/made-by-roxygen/with-header.Rd
tests/testthat/made-by-roxygen/empty.Rd
tests/testthat/made-by-roxygen/without-header.Rd
tests/testthat/testCollateOverwrite
tests/testthat/testCollateOverwrite/R
tests/testthat/testCollateOverwrite/R/b.r
tests/testthat/testCollateOverwrite/R/a.r
tests/testthat/testCollateOverwrite/DESCRIPTION
tests/testthat/testLazyData
tests/testthat/testLazyData/NAMESPACE
tests/testthat/testLazyData/data
tests/testthat/testLazyData/data/a.rda
tests/testthat/testLazyData/R
tests/testthat/testLazyData/R/a.r
tests/testthat/testLazyData/DESCRIPTION
tests/testthat/testCollateNoIncludes
tests/testthat/testCollateNoIncludes/NAMESPACE
tests/testthat/testCollateNoIncludes/R
tests/testthat/testCollateNoIncludes/R/b.r
tests/testthat/testCollateNoIncludes/R/a.r
tests/testthat/testCollateNoIncludes/DESCRIPTION
tests/testthat/test-select_args.R
tests/testthat/test-rd-markdown-links.R
tests/testthat/test-rd-doctype.R
tests/testthat/helper-pkg.R
tests/testthat/test-rd-family.R
tests/testthat/test-object-s4.R
tests/testthat/test-rd-param.R
tests/testthat/test-parse.R
tests/testthat/description-example_2.txt
tests/testthat/test-nonASCII.R
tests/testthat/helper-test.R
tests/testthat/test-rd-markdown-on-off.R
tests/testthat/test-rd-keyword.R
tests/testthat/testEagerData
tests/testthat/testEagerData/data
tests/testthat/testEagerData/data/a.rda
tests/testthat/testEagerData/R
tests/testthat/testEagerData/R/a.r
tests/testthat/testEagerData/DESCRIPTION
tests/testthat/test-rd-markdown-escaping.R
tests/testthat/test-object.R
tests/testthat/test-rd-introduction.R
tests/testthat/test-Rbuildignore.R
tests/testthat/test-rd-backref.R
tests/testthat/test-object-rc.R
tests/testthat/test-rd-data.R
tests/testthat/test-rd-markdown.R
tests/testthat/helper-env.R
tests/testthat/Rd-example-1.R
tests/testthat/test-parse-block.R
tests/testthat/test-topic.R
tests/testthat/test-namespace.R
tests/testthat/Rd-example-5.R
tests/testthat/Rd-example-2.R
tests/testthat/test-rd-package.R
tests/testthat/test-nice-name.R
tests/testthat/test-object-format.R
tests/testthat/test-rd-usage.R
tests/testthat/description-example.txt
src
src/leadingSpaces.cpp
src/isComplete.cpp
src/parser2.cpp
src/wrapString.cpp
src/RcppExports.cpp
NAMESPACE
NEWS.md
R
R/rd-describe-in.R
R/object-defaults.R
R/utils-rd.R
R/roxygen.R
R/utils.R
R/topo-sort.R
R/tag.R
R/topic.R
R/markdown.R
R/rd-family.R
R/enc.R
R/object-rc.R
R/roxygenize.R
R/collate.R
R/object-from-call.R
R/field.R
R/rd-params.R
R/object-usage.R
R/namespace.R
R/object.R
R/safety.R
R/rd-template.R
R/rd-inherit.R
R/markdown-escaping.R
R/RcppExports.R
R/rd.R
R/object-s3.R
R/parse.R
R/select-args.R
R/object-name.R
R/util-locale.R
R/source.R
R/vignette.R
R/roclet.R
R/object-format.R
R/topics.R
R/object-package.R
vignettes
vignettes/rdkeywords.md
vignettes/namespace.Rmd
vignettes/releases
vignettes/releases/roxygen2-6.0.0.Rmd
vignettes/collate.md
vignettes/markdown.Rmd
vignettes/rd.md
vignettes/rd.Rmd
vignettes/formatting.md
vignettes/collate.Rmd
vignettes/markdown.md
vignettes/roxygen2.md
vignettes/rdkeywords.Rmd
vignettes/roxygen2.Rmd
vignettes/formatting.Rmd
vignettes/namespace.md
README.md
MD5
build
build/vignette.rds
DESCRIPTION
man
man/double_escape_md.Rd
man/is_s3_generic.Rd
man/roxygen2-package.Rd
man/roc_proc_text.Rd
man/vignette_roclet.Rd
man/markdown-test.Rd
man/roclet.Rd
man/rd_roclet.Rd
man/source_package.Rd
man/update_collate.Rd
man/object_format.Rd
man/markdown-internals.Rd
man/roxygenize.Rd
man/object.Rd
man/namespace_roclet.Rd
man/load_options.Rd
man/roclet_find.Rd
man/roxy_tag.Rd
roxygen2 documentation built on May 20, 2017, 1:01 a.m.

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

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

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