Package: roxygen2 7.3.2
![](https://github.com/cran/roxygen2/raw/HEAD/man/figures/logo.png)
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_7.3.2.tar.gz
roxygen2_7.3.2.tar.gz(r-4.5-noble)roxygen2_7.3.2.tar.gz(r-4.4-noble)
roxygen2_7.3.2.tgz(r-4.4-emscripten)roxygen2_7.3.2.tgz(r-4.3-emscripten)
roxygen2.pdf |roxygen2.html✨
roxygen2/json (API)
NEWS
# Installroxygen2 in R: |
install.packages('roxygen2',repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/r-lib/roxygen2/issues
Last updated 8 days agofrom:2a06a45f97
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.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2019-11-12
Documenting functions
Rendered fromrd.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2014-05-02
Documenting other objects
Rendered fromrd-other.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-23
Started: 2022-07-18
Extending roxygen2
Rendered fromextending.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2019-11-12
Get started with roxygen2
Rendered fromroxygen2.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2014-05-02
Indexing and cross-references
Rendered fromindex-crossref.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2022-07-18
Managing imports and exports
Rendered fromnamespace.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2014-05-02
Reusing documentation
Rendered fromreuse.Rmd
usingknitr::rmarkdown
on Jun 28 2024.Last update: 2024-01-11
Started: 2022-07-18
Readme and manuals
Help Manual
Help page | Topics |
---|---|
Load package code | load load_installed load_pkgload load_source |
Roclet: make 'NAMESPACE' | namespace_roclet |
Roclet: make Rd files | rd_roclet |
Process a package with the Rd, namespace and collate roclets | roxygenise 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 |