Generics | Classes | Methods | Methods for generics in other packages
This package is considered a duplicate. The official version of this package is found at:https://r-lib.r-universe.dev/roxygen2
Package: roxygen2 8.0.0.9000
Hadley Wickham
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++.
Authors:
roxygen2_8.0.0.9000.tar.gz
roxygen2_8.0.0.9000.zip(r-4.7)roxygen2_8.0.0.9000.zip(r-4.6)roxygen2_8.0.0.9000.zip(r-4.5)
roxygen2_8.0.0.9000.tgz(r-4.6-x86_64)roxygen2_8.0.0.9000.tgz(r-4.6-arm64)roxygen2_8.0.0.9000.tgz(r-4.5-x86_64)roxygen2_8.0.0.9000.tgz(r-4.5-arm64)
roxygen2_8.0.0.9000.tar.gz(r-4.7-arm64)roxygen2_8.0.0.9000.tar.gz(r-4.7-x86_64)roxygen2_8.0.0.9000.tar.gz(r-4.6-arm64)roxygen2_8.0.0.9000.tar.gz(r-4.6-x86_64)
roxygen2_8.0.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
roxygen2/json (API)
| # Install 'roxygen2' in R: |
| install.packages('roxygen2', repos = c('https://poissonconsulting.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/r-lib/roxygen2/issues
Pkgdown/docs site:https://roxygen2.r-lib.org
Last updated from:55e7dea4e2. Checks:13 OK. Indexed: no.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-arm64 | OK | 197 | ||
| linux-devel-x86_64 | OK | 153 | ||
| source / vignettes | OK | 221 | ||
| linux-release-arm64 | OK | 185 | ||
| linux-release-x86_64 | OK | 189 | ||
| macos-release-arm64 | OK | 146 | ||
| macos-release-x86_64 | OK | 222 | ||
| macos-oldrel-arm64 | OK | 138 | ||
| macos-oldrel-x86_64 | OK | 280 | ||
| windows-devel | OK | 137 | ||
| windows-release | OK | 141 | ||
| windows-oldrel | OK | 129 | ||
| wasm-release | OK | 121 |
Exports:block_get_tagblock_get_tag_valueblock_get_tagsblock_has_tagsenv_fileenv_packageescape_examplesis_s3_genericis_s3_methodload_installedload_optionsload_pkgloadload_sourcenamespace_rocletneeds_roxygenizeobjectobject_formatparse_fileparse_packageparse_textrd_rocletrd_sectionroc_proc_textrocletroclet_cleanroclet_findroclet_outputroclet_preprocessroclet_processroclet_tagsroxy_blockroxy_meta_getroxy_tagroxy_tag_parseroxy_tag_rdroxy_tag_warningroxygeniseroxygenizetag_codetag_examplestag_inherittag_markdowntag_markdown_with_sectionstag_nametag_name_descriptiontag_toggletag_two_parttag_valuetag_wordstag_words_linetags_listtags_metadataupdate_collatevignette_rocletwarn_roxy_tag
Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecycleotelpkgbuildpkgloadprocessxpsR6rlangrprojrootwithrxfunxml2yaml
Documenting S3
Last update: 2026-06-25
Started: 2026-04-10
(R)Markdown support
Enabling markdown support | Basic syntax | Sections and subsections | Inline formatting | Code | Lists | Tables | Links | Images | Function links | Code chunks | Chunk options | Possible problems | Some Rd tags can't contain markdown | Mixing Markdown and Rd markup | Leading white space | Spurious lists
Last update: 2026-04-22
Started: 2019-08-13
Documenting datasets
Last update: 2026-04-22
Started: 2026-04-10
Documenting functions
Exporting | The introduction | Title | Description | Details | Required tags | Inputs | Outputs | Examples | Usage
Last update: 2026-04-22
Started: 2026-04-10
Documenting packages
Last update: 2026-04-22
Started: 2026-04-10
Documenting R6
Classes | Fields and active bindings | Methods | Dynamic methods | Opting out
Last update: 2026-04-22
Started: 2026-04-10
Documenting S4
Generics | Classes | Methods
Last update: 2026-04-22
Started: 2026-04-10
Documenting S7
Generics | Classes | Methods
Last update: 2026-04-22
Started: 2026-04-10
Extending roxygen2
How roxygenize() works | Key data structures | Tags | Blocks | Adding a new .Rd tag | Using your new tag | Creating a new roclet | Custom tags | The roclet | Adding a roclet to your workflow | Conclusion: further extension ideas
Last update: 2026-04-22
Started: 2019-09-18
Get started with roxygen2
Basics | Running roxygen | Basic process: human readable documentation | Basic process: making functions available to users | Learn more
Last update: 2026-04-22
Started: 2014-02-05
Indexing and cross-references
See also | Family | References | Aliases | Search | Back references
Last update: 2026-04-22
Started: 2022-07-15
Managing imports and exports
Exports | Manual exports | Imports | Functions | S3 | S4 | Compiled code
Last update: 2026-04-22
Started: 2014-02-06
Reusing documentation
Multiple functions in the same topic | @rdname | @describeIn | Order of includes | Automatically copy tags | Parameters | Recursive inheritance | Multiple parameters | The dot prefix | Inheriting other components | Documenting ... | Inheriting from other packages | Custom tags | Inline code | Inline Rd code | Child documents | Superseded
Last update: 2026-04-22
Started: 2022-07-09
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Load package code | load load_installed load_pkgload load_source |
| Load roxygen2 options | load_options roxy_meta_get |
| Roclet: make 'NAMESPACE' | namespace_roclet |
| Check if documentation needs to be updated | needs_roxygenize |
| Parse a package, file, or inline code | env_file env_package parse_file parse_package parse_text |
| Roclet: make Rd files | rd_roclet |
| Construct an 'rd_section' object | rd_section |
| Process roclet on string and capture results | roc_proc_text |
| Create a roclet from a string | roclet_find |
| Blocks | block_get_tag block_get_tags block_get_tag_value block_has_tags roxy_block |
| 'roxy_tag' S3 constructor | roxy_tag roxy_tag_parse roxy_tag_warning warn_roxy_tag |
| Generate Rd output from a tag | roxy_tag_rd |
| Document a package with roxygen2 | roxygenise roxygenize |
| Parse tags | tag_code tag_examples tag_inherit tag_markdown tag_markdown_with_sections tag_name tag_name_description tag_parsers tag_toggle tag_two_part tag_value tag_words tag_words_line |
| Access metadata about built-in or available tags | tags_list tags_metadata |
| Tags for indexing and cross-references | @aliases @backref @concept @family @keywords @references @seealso tags-index-crossref |
| Tags for managing the 'NAMESPACE' | @evalNamespace @export @exportClass @exportMethod @exportPattern @exportS3Method @import @importClassesFrom @importFrom @importMethodsFrom @rawNamespace @useDynLib tags-namespace |
| Tags for documenting datasets | @format @source tags-rd-datasets |
| Tags related to markdown support | @md @noMd @section tags-rd-formatting |
| Tags for documenting functions | @description @details @example @examples @examplesIf @noRd @param @rawRd @return @returns @title @usage tags-rd-functions |
| Tags for documenting R6 | @field @R6method tags-rd-R6 |
| Tags for documenting S3 | @method tags-rd-S3 |
| Tags for documenting S4 | @slot tags-rd-S4 |
| Tags for documenting S7 | @prop tags-rd-S7 |
| Tags that help you reuse documentation | @describeIn @eval @evalRd @includeRmd @inherit @inheritDotParams @inheritParams @inheritSection @order @rdname @template @templateVar tags-reuse |
| Update Collate field in DESCRIPTION | @include update_collate |
