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.2.0
Depends: R (≥ 3.3)
Imports: brew, cli (≥ 3.3.0), commonmark, desc (≥ 1.2.0), digest, knitr, methods, pkgload (≥ 1.0.2), purrr (≥ 0.3.3), R6 (≥ 2.1.2), rlang (≥ 1.0.0), stringi, stringr (≥ 1.0.0), utils, withr, xml2
LinkingTo: cpp11
Suggests: covr, R.methodsS3, R.oo, rmarkdown, testthat (≥ 3.1.2)
Published: 2022-05-13
Author: Hadley Wickham ORCID iD [aut, cre, cph], Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph, fnd]
Maintainer: Hadley Wickham <hadley at rstudio.com>
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
SystemRequirements: C++11
Language: en-GB
Materials: README NEWS
CRAN checks: roxygen2 results

Documentation:

Reference manual: roxygen2.pdf
Vignettes: Extending roxygen2
NAMESPACE tags
Rd formatting
Rd (documentation) tags
Getting started with roxygen2

Downloads:

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

Reverse dependencies:

Reverse depends: miscFuncs, roxut
Reverse imports: anyflights, aoos, attachment, devtools, docstring, document, exampletestr, fusen, golem, icesTAF, languageserver, leprechaun, link2GI, mdapack, packer, populationPDXdesign, Rd2roxygen, redland, roclang, roxytest, zoon
Reverse suggests: activatr, additive, admiral, AFR, AgroR, AirMonitor, airpart, alfr, altadata, annotatr, anomalize, aRxiv, audubon, autoshiny, aweek, bacon, BAS, bayesian, BayesianLaterality, BayesianTools, bdclean, bigPint, bioC.logs, biodb, biodbChebi, biodbExpasy, biodbHmdb, biodbKegg, biodbLipidmaps, biodbMirbase, biodbNcbi, biodbNci, biodbUniprot, biscuiteer, bit, boot.heterogeneity, bootGOF, box, broman, buildr, bunchr, campsis, campsismod, camsRad, cargo, catalog, cattonum, CBEA, celda, censable, chimeraviz, chipenrich, chipenrich.data, circRNAprofiler, circumplex, civis, clustermole, clustermq, cmna, codebook, concurve, condTruncMVN, CornerstoneR, covid19.analytics, crul, ctf, deconvR, decoupleR, denvax, DepthProc, DescribeDisplay, discreteRV, dispositionEffect, divseg, dodgr, doremi, dotCall64, dr4pl, DrImpute, DSAIDE, DSAIRM, dynr, earlyR, ebreg, ecd, edgarWebR, EDIutils, emayili, EpiDISH, epiflows, epigraphdb, epitrix, epivizr, epivizrChart, epivizrData, EventDetectGUI, expp, expstudy, ezcox, factory, fakemake, faux, FedData, ferrn, ffp, fgdr, fgeo.tool, fitzRoy, flippant, forecastHybrid, gapfill, GenomicSuperSignature, GenVisR, GEOfastq, geometa, geomtextpath, geonapi, geonetwork, geosapi, geozoo, getlandsat, geva, GGally, ggenealogy, ggpacman, GladiaTOX, gMOIP, googleAuthR, googledrive, gppm, gqlr, GSODR, hardhat, healthyR, healthyR.ai, healthyR.ts, healthyverse, heddlr, HiClimR, HMP16SData, HMP2Data, hoardr, hopit, howManyImputations, httping, ibb, idr2d, ifaTools, iheatmapr, immunarch, incidence2, inlmisc, insane, intergraph, interplex, ipmr, IRkernel, ISAnalytics, jiebaR, JSmediation, jubilee, knitrBootstrap, konfound, labelmachine, latticeDensity, ldamatch, ldhmm, learnrbook, leontief, lineup, lineup2, lmQCM, logger, LRcell, LRcellTypeMarkers, LWFBrook90R, mapsRinteractive, mase, mason, MAST, matrixNormal, MazamaCoreUtils, MazamaLocationUtils, MazamaRollUtils, MazamaSpatialPlots, MazamaTimeSeries, mbmixture, mc.heterogeneity, mcmcsae, memofunc, metaconfoundr, metagam, metan, metawho, mgarchBEKK, micompr, migraph, miniCRAN, mizer, MMAPPR2, MMAPPR2data, MobilityTransformR, modeltime, modeltime.ensemble, modeltime.gluonts, modeltime.h2o, modeltime.resample, Momocs, MoonlightR, mrbayes, mregions, MsBackendMassbank, MsBackendMgf, MsBackendMsp, MsCoreUtils, MsFeatures, msgbsR, msmtools, MSnbase, mtconnectR, multipanelfigure, mwcsr, naaccr, NACHO, NanoStringQCPro, NasdaqDataLink, nat.utils, negenes, net4pg, nhlapi, nima, nlmeU, NMproject, noisyr, NormalyzerDE, nprcgenekeepr, nscancor, nseval, nsprcomp, nzffdr, ompBAM, openadds, OpenMx, openxlsx, oppr, optimParallel, optmatch, packager, paleobioDB, pcIRT, PerseusR, pestr, pguIMP, photobiology, pkgKitten, pkgmaker, pkgstats, poorman, popEpi, PosteriorBootstrap, PP, PPforest, ppmf, PracTools, PRDA, precommit, prioriactions, prioritizr, prioritizrdata, proBatch, ProcMod, projections, pRoloc, pspline.inference, psycModel, pwrRasch, qsort, qtl2, qtl2convert, qtl2ggplot, qtlcharts, Quandl, questionr, r2dii.analysis, r3PG, R4CouchDB, ragtop, rappdirs, RAQSAPI, rbgm, rbokeh, rcoreoa, RcppProgress, rcrossref, RCzechia, rddapp, rdwd, recexcavAAR, regport, ReplicationSuccess, restoptr, rex, RItools, rmdpartials, rnoaa, roadoi, Rpadrino, rpf, RQEntangle, rsdmx, rsetse, RSocrata, rstanarm, rstantools, Rwtss, rYoutheria, sarsop, scholar, scriptexec, sdmvspecies, seedreg, semverutils, sgsR, shapr, sigminer, simcross, SimRVPedigree, sinew, siteymlgen, smapr, SMMT, smog, smurf, sotkanet, SpaDES.core, sparsenetgls, spdynmod, Spectra, SpidermiR, sportyR, spsurv, SSP, StarBioTrek, STATegRa, stencilaschema, StructuralVariantAnnotation, styler, SurfaceTortoise, svaNUMT, svaRetro, taxa, taxlist, TCGAbiolinksGUI, tcpl, Tejapi, testthis, textfeatures, TidyDensity, tidyHeatmap, tidywikidatar, timetk, tinyscholar, tmt, trampoline, transite, transomics2cytoscape, ubms, unnest, unstruwwel, unusualprofile, usethis, valmetrics, valse, vcr, vdiffr, vegtable, viafr, Visualize.CRAN.Downloads, waddR, wdpar, worrms, wrswoR, WufooR, xoi, yamlme, ymlthis, zmisc, zzlite

Linking:

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