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

Version: 7.3.1
Depends: R (≥ 3.6)
Imports: brew, cli (≥ 3.3.0), commonmark, desc (≥ 1.2.0), knitr, methods, pkgload (≥ 1.0.2), purrr (≥ 1.0.0), R6 (≥ 2.1.2), rlang (≥ 1.0.6), stringi, stringr (≥ 1.0.0), utils, withr, xml2
LinkingTo: cpp11
Suggests: covr, R.methodsS3, R.oo, rmarkdown (≥ 2.16), testthat (≥ 3.1.2), yaml
Published: 2024-01-22
Author: Hadley Wickham ORCID iD [aut, cre, cph], Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], Posit Software, PBC [cph, fnd]
Maintainer: Hadley Wickham <hadley at posit.co>
BugReports: https://github.com/r-lib/roxygen2/issues
License: MIT + file LICENSE
URL: https://roxygen2.r-lib.org/, https://github.com/r-lib/roxygen2
NeedsCompilation: yes
Language: en-GB
Materials: README NEWS
CRAN checks: roxygen2 results

Documentation:

Reference manual: roxygen2.pdf
Vignettes: Extending roxygen2
Indexing and cross-references
Managing imports and exports
(R)Markdown support
Documenting other objects
Documenting functions
Reusing documentation
Get started with roxygen2

Downloads:

Package source: roxygen2_7.3.1.tar.gz
Windows binaries: r-prerel: roxygen2_7.3.1.zip, r-release: roxygen2_7.3.1.zip, r-oldrel: roxygen2_7.3.1.zip
macOS binaries: r-prerel (arm64): roxygen2_7.3.1.tgz, r-release (arm64): roxygen2_7.3.1.tgz, r-oldrel (arm64): roxygen2_7.3.1.tgz, r-prerel (x86_64): roxygen2_7.3.1.tgz, r-release (x86_64): roxygen2_7.3.1.tgz
Old sources: roxygen2 archive

Reverse dependencies:

Reverse depends: miscFuncs, roxut
Reverse imports: anyflights, aoos, attachment, checkhelper, devtools, docstring, doctest, document, exampletestr, fusen, icesTAF, languageserver, leprechaun, link2GI, makepipe, packer, populationPDXdesign, Rd2roxygen, redland, roclang, roxyglobals, roxylint, roxytest, roxytypes
Reverse suggests: activatr, additive, admiral.test, admiraldev, admiralonco, admiralophtha, admiralvaccine, AFR, agghoo, AgroR, AirMonitor, airpart, alfr, altadata, annotatr, anomalize, aRxiv, audubon, autoshiny, aweek, bacon, baizer, bark, BAS, bayesian, BayesianLaterality, BayesianTools, BayesRep, BayesRepDesign, Bernadette, bioC.logs, biodb, biodbChebi, biodbExpasy, biodbHmdb, biodbKegg, biodbLipidmaps, biodbMirbase, biodbNcbi, biodbNci, biodbUniprot, biscuiteer, bit, boot.heterogeneity, bootGOF, box, broman, BRVM, buildr, bunchr, bursa, campsis, campsismod, camsRad, cargo, catalog, causalBatch, CBEA, celda, censable, cfdnakit, chimeraviz, chipenrich, chipenrich.data, chromer, ciCalibrate, circRNAprofiler, circumplex, civis, clugenr, clustermole, clustermq, cmna, codebook, CohortSurvival, collatz, condTruncMVN, constructive, cookies, CornerstoneR, covid19.analytics, crul, ctf, D4TAlink.light, datacutr, dcm2, debkeepr, deconvR, decoupleR, denguedatahub, denvax, DepthProc, designit, DEXSeq, discreteRV, dispositionEffect, divseg, dodgr, doremi, dotCall64, dr4pl, DrImpute, DSAIDE, DSAIRM, dynr, earlyR, ebreg, edgarWebR, EDIutils, eiExpand, emayili, EpiDISH, epiflows, epigraphdb, epitrix, epivizr, epivizrChart, epivizrData, EventDetectGUI, expstudy, ezcox, factory, fakemake, faux, ferrn, ffp, fgdr, fgeo.tool, fitzRoy, flippant, forecastHybrid, fscache, gapfill, GenomicSuperSignature, GenVisR, GEOfastq, geometa, geomtextpath, geonapi, geonetwork, geosapi, geozoo, geva, ggalignment, GGally, ggDoE, ggenealogy, gibasa, GladiaTOX, gMOIP, golem, googleAuthR, gqlr, hardhat, HDMAADMM, healthyR, healthyR.ai, healthyR.ts, healthyverse, heddlr, HiClimR, HMP16SData, HMP2Data, hopit, howManyImputations, httping, hyd1d, hydflood, HyMETT, ibb, idr2d, ifaTools, iheatmapr, immunarch, inlcolor, inldata, insane, intergraph, interplex, ipmr, IRkernel, ISAnalytics, isobxr, izmir, jiebaR, JSmediation, jubilee, knitrBootstrap, konfound, labelmachine, latrend, lcc, ldamatch, ldhmm, learnrbook, leontief, lineup, lineup2, litterfitter, lmQCM, logger, LRcell, LRcellTypeMarkers, LWFBrook90R, MacBehaviour, manynet, mapsRinteractive, marp, mase, MAST, matrixNormal, MazamaCoreUtils, MazamaLocationUtils, MazamaRollUtils, MazamaSpatialPlots, MazamaTimeSeries, mbmixture, mc.heterogeneity, mcmcsae, measr, memofunc, metaconfoundr, metagam, metan, metawho, mgarchBEKK, micompr, migraph, miniCRAN, mizer, MMAPPR2data, mmconvert, MobilityTransformR, modeltime, modeltime.resample, Momocs, Moonlight2R, MoonlightR, morpheus, mrbayes, MsBackendMassbank, MsBackendMgf, MsBackendMsp, MsBackendSql, MsCoreUtils, MsExperiment, MsFeatures, msgbsR, mslp, msmtools, MSnbase, mtscr, multibreakeR, multipanelfigure, mwcsr, naaccr, NACHO, NasdaqDataLink, nat.utils, negenes, nestedmodels, net4pg, new.dist, nhlapi, nima, nlmeU, noisyr, NormalyzerDE, nscancor, nseval, nsprcomp, nzffdr, ompBAM, ontophylo, OpenMx, openxlsx, oppr, optimParallel, options, optmatch, packager, paleobioDB, pasilla, pcIRT, PerseusR, pestr, pharmaverseadam, pharmaversesdtm, photobiology, pkgKitten, pkgmaker, POMADE, poorman, popEpi, PosteriorBootstrap, PP, PPforest, ppmf, ppRep, PracTools, PRDA, precommit, prioriactions, prioritizrdata, ProcMod, projections, pRoloc, pspline.inference, psycCleaning, psycModel, public.ctn0094data, pwrRasch, qsort, qtl2, qtl2convert, qtl2ggplot, qtlcharts, QuadratiK, Quandl, questionr, r2dii.analysis, r3PG, R4CouchDB, ragtop, rappdirs, raptr, RAQSAPI, rbgm, RcppProgress, rcrossref, RCzechia, rddapp, rdtLite, rdwd, recexcavAAR, REDCapCAST, regport, ReplicationSuccess, restoptr, rex, rgeoboundaries, RItools, rmdpartials, roadoi, robotoolbox, robustmatrix, Rpadrino, rpf, RQEntangle, rsdmx, rsetse, RSocrata, rstanarm, rstantools, Rwtss, rYoutheria, sarsop, SCDB, scholar, scriptexec, sdmvspecies, seedreg, semverutils, sgsR, shapr, sherlock, sigminer, simcross, sinew, siteymlgen, SMMT, smurf, sotkanet, sparsenetgls, spdynmod, Spectra, SpidermiR, spsurv, SSP, StarBioTrek, STATegRa, stencilaschema, StructuralVariantAnnotation, styler, SurfaceTortoise, surveyvoi, svaNUMT, svaRetro, symSEM, taxa, tcpl, TDCM, tectonicr, Tejapi, testex, testthis, TidyDensity, tidyHeatmap, tinycodet, tinyscholar, tmt, tnl.Test, trampoline, transite, transomics2cytoscape, turkeyelections, tutorial.helpers, ubms, ukbnmr, unnest, unstruwwel, unusualprofile, ura, urlshorteneR, usethis, validateIt, valmetrics, valse, vcr, vdiffr, viafr, Visualize.CRAN.Downloads, waddR, wdpar, webmap, wikkitidy, worrms, wrswoR, WufooR, xoi, ymlthis, ZINAR1, zmisc, zzlite

Linking:

Please use the canonical form https://CRAN.R-project.org/package=roxygen2 to link to this page.