Package: roxygen2 7.3.2.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:Hadley Wickham [aut, cre, cph], Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], Posit Software, PBC [cph, fnd]

roxygen2_7.3.2.9000.tar.gz
roxygen2_7.3.2.9000.zip(r-4.5)roxygen2_7.3.2.9000.zip(r-4.4)roxygen2_7.3.2.9000.zip(r-4.3)
roxygen2_7.3.2.9000.tgz(r-4.4-x86_64)roxygen2_7.3.2.9000.tgz(r-4.4-arm64)roxygen2_7.3.2.9000.tgz(r-4.3-x86_64)roxygen2_7.3.2.9000.tgz(r-4.3-arm64)
roxygen2_7.3.2.9000.tar.gz(r-4.5-noble)roxygen2_7.3.2.9000.tar.gz(r-4.4-noble)
roxygen2_7.3.2.9000.tgz(r-4.4-emscripten)roxygen2_7.3.2.9000.tgz(r-4.3-emscripten)
roxygen2.pdf |roxygen2.html
roxygen2/json (API)
NEWS

# Install 'roxygen2' in R:
install.packages('roxygen2', repos = c('https://r-lib.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/r-lib/roxygen2/issues

Pkgdown:https://roxygen2.r-lib.org

Uses libs:
  • c++– GNU Standard C++ Library v3

On CRAN:

devtoolsdocumentation

18.84 score 594 stars 212 packages 2.4k scripts 180k downloads 14 mentions 54 exports 28 dependencies

Last updated 4 months agofrom:9652d15221. Checks:OK: 9. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 19 2024
R-4.5-win-x86_64OKNov 19 2024
R-4.5-linux-x86_64OKNov 19 2024
R-4.4-win-x86_64OKNov 19 2024
R-4.4-mac-x86_64OKNov 19 2024
R-4.4-mac-aarch64OKNov 19 2024
R-4.3-win-x86_64OKNov 19 2024
R-4.3-mac-x86_64OKNov 19 2024
R-4.3-mac-aarch64OKNov 19 2024

Exports:block_get_tagblock_get_tag_valueblock_get_tagsblock_has_tagsenv_fileenv_packageescape_examplesis_s3_genericis_s3_methodload_installedload_optionsload_pkgloadload_sourcenamespace_rocletobjectobject_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:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecyclemagrittrpkgbuildpkgloadprocessxpspurrrR6rlangrprojrootstringistringrvctrswithrxfunxml2yaml

(R)Markdown support

Rendered fromrd-formatting.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2024-08-01
Started: 2019-08-13

Documenting functions

Rendered fromrd.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2023-11-02
Started: 2014-02-06

Documenting other objects

Rendered fromrd-other.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2024-07-09
Started: 2022-07-09

Extending roxygen2

Rendered fromextending.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2023-11-06
Started: 2019-09-18

Get started with roxygen2

Rendered fromroxygen2.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2023-11-15
Started: 2014-02-05

Indexing and cross-references

Rendered fromindex-crossref.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2023-11-02
Started: 2022-07-15

Managing imports and exports

Rendered fromnamespace.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2024-07-09
Started: 2014-02-06

Reusing documentation

Rendered fromreuse.Rmdusingknitr::rmarkdownon Nov 19 2024.

Last update: 2024-07-09
Started: 2022-07-09

Readme and manuals

Help Manual

Help pageTopics
Load package codeload load_installed load_pkgload load_source
Roclet: make 'NAMESPACE'namespace_roclet
Roclet: make Rd filesrd_roclet
Process a package with the Rd, namespace and collate rocletsroxygenise roxygenize
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 functions@description @details @example @examples @examplesIf @noRd @param @rawRd @return @returns @title @usage tags-rd
Tags related to markdown support@md @noMd @section tags-rd-formatting
Tags for documenting datasets and classes@field @format @method @slot @source tags-rd-other
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