Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

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++.

Functions (26)

RoxyTopic

A RoxyTopic is an ordered collection of unique rd_sections

double_escape_md

Check markdown escaping

escape_examples

Escape examples

is_s3_generic

Determine if a function is an S3 generic or S3 method.

load

Load package code

load_options

Load roxygen2 options

markdown-internals

Escape Rd markup, to avoid interpreting it as markdown

markdown-test

Dummy page to test roxygen's markdown formatting

markdown_pass1

Expand the embedded inline code

namespace_roclet

Roclet: make NAMESPACE

object

Constructors for S3 object to represent R objects.

object_format

Default format for data

parse_package

Parse a package, file, or inline code

rd_roclet

Roclet: make Rd files.

rd_section

Construct an rd_section object

roc_proc_text

Process roclet on string and capture results.

roclet

Build a new roclet.

roclet_find

Create a roclet from a string.

roxy_block

Blocks

roxy_tag

roxy_tag S3 constructor

roxy_tag_rd

Generate Rd output from a tag

roxygen2-package

roxygen2: In-Line Documentation for R

roxygenize

Process a package with the Rd, namespace and collate roclets.

tag_parsers

Parse tags

update_collate

Update Collate field in DESCRIPTION

vignette_roclet

Re-build outdated vignettes.

roxygen2

In-Line Documentation for R

v7.1.1

GPL (>= 2)

Authors

Hadley Wickham [aut, cre, cph] (<https://orcid.org/0000-0003-4757-117X>), Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph]

Initial release

roxygen2

Functions (26)

roxygen2

We don't support your browser anymore