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.1.1
Depends: R (≥ 3.2)
Imports: brew, commonmark, desc (≥ 1.2.0), digest, knitr, methods, pkgload (≥ 1.0.2), purrr (≥ 0.3.3), R6 (≥ 2.1.2), Rcpp (≥ 0.11.0), rlang, stringi, stringr (≥ 1.0.0), utils, xml2
LinkingTo: Rcpp
Suggests: covr, devtools, rmarkdown, testthat (≥ 2.1.0), R.methodsS3, R.oo
Published: 2020-06-27
Author: Hadley Wickham ORCID iD [aut, cre, cph], Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph]
Maintainer: Hadley Wickham <hadley at rstudio.com>
BugReports: https://github.com/r-lib/roxygen2/issues
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
URL: https://roxygen2.r-lib.org/, https://github.com/r-lib/roxygen2
NeedsCompilation: yes
Language: en-GB
Materials: README NEWS
CRAN checks: roxygen2 results

Downloads:

Reference manual: roxygen2.pdf
Vignettes: Extending roxygen2
NAMESPACE tags
Rd formatting
Rd (documentation) tags
Getting started with roxygen2
Package source: roxygen2_7.1.1.tar.gz
Windows binaries: r-devel: roxygen2_7.1.1.zip, r-release: roxygen2_7.1.1.zip, r-oldrel: roxygen2_7.1.1.zip
macOS binaries: r-release: roxygen2_7.1.1.tgz, r-oldrel: roxygen2_7.1.1.tgz
Old sources: roxygen2 archive

Reverse dependencies:

Reverse depends: miscFuncs, roxut, sqlutils
Reverse imports: aoos, attachment, cartools, devtools, docstring, document, exampletestr, golem, link2GI, mdapack, populationPDXdesign, Rd2roxygen, redland, RGalaxy, roxytest, RSuite, zoon
Reverse suggests: alfr, annotatr, anomalize, aRxiv, autoshiny, aweek, bacon, BAS, BayesianTools, bdclean, bigPint, binomialMix, bioC.logs, biscuiteer, bit, bomrang, boot.heterogeneity, broman, bunchr, camsRad, cattonum, ccafs, celda, CHARGE, chimeraviz, chipenrich, chipenrich.data, chromer, circRNAprofiler, circumplex, civis, clustermole, clustermq, cmna, codebook, concurve, CornerstoneR, CountClust, covid19.analytics, crminer, crul, curatedMetagenomicData, deisotoper, denvax, DescribeDisplay, discreteRV, dodgr, doremi, dotCall64, dr4pl, DrImpute, DSAIDE, DSAIRM, dynr, earlyR, ebreg, ecd, emayili, EpiDISH, epiflows, epitrix, epivizr, epivizrChart, epivizrData, eurostat, EventDetectGUI, expp, ezcox, factory, fakemake, fauxnaif, FedData, felp, fgdr, fgeo.tool, fitzRoy, forecastHybrid, fulltext, gapfill, GenVisR, geometa, geonapi, geonetwork, geoops, geosapi, geozoo, getCRUCLdata, getlandsat, GGally, ggenealogy, ggpacman, gitlabr, GladiaTOX, gMOIP, googleAuthR, googledrive, gppm, gqlr, GSODR, hardhat, heddlr, HiClimR, HMP16SData, HMP2Data, hoardr, hopit, httping, icd, idr2d, ifaTools, iheatmapr, immunarch, inlmisc, intergraph, IRkernel, ItemResponseTrees, jaod, jiebaR, jqr, JSmediation, jubilee, knitrBootstrap, labelmachine, latticeDensity, lawn, lcc, ldhmm, learnrbook, lineup, lmQCM, logger, loose.rock, mapsRinteractive, mase, mason, MAST, matrixNormal, MazamaCoreUtils, MazamaLocationUtils, mc.heterogeneity, metagam, metan, metawho, mgarchBEKK, micompr, miniCRAN, mizer, MMAPPR2, MMAPPR2data, modeltime, Momocs, MoonlightR, morpheus, mrbayes, mregions, MsCoreUtils, msgbsR, MSnbase, mtconnectR, multipanelfigure, naaccr, NACHO, NanoStringQCPro, nat.utils, negenes, nhlapi, nima, nlmeU, NormalyzerDE, nprcgenekeepr, nscancor, nseval, nsprcomp, oai, openadds, OpenMx, openxlsx, oppr, optimParallel, optmatch, osmdata, osmplotr, paleobioDB, pcIRT, PerseusR, photobiology, pkgmaker, pleiades, pnn, poorman, popEpi, PP, PPforest, precommit, prioritizr, prioritizrdata, proBatch, ProcMod, projections, pRoloc, protoclass, pspline.inference, pwrRasch, pxweb, qsort, qtl2, qtl2convert, qtlcharts, Quandl, questionr, r2dii.analysis, r3PG, R4CouchDB, radiomics, ragtop, randomsearch, rappdirs, raptr, rAvis, rbgm, rbokeh, rbundler, rClinicalCodes, rcoreoa, RcppProgress, rcrossref, RCzechia, rdtLite, rdwd, recexcavAAR, rerddap, rerf, rex, rif, riskyr, ritis, RItools, rmdpartials, rnoaa, roadoi, rpcdsearch, rpf, RQEntangle, rsdmx, RSocrata, rstanarm, rstantools, rYoutheria, sarsop, scholar, scriptexec, sdmvspecies, SDraw, semverutils, sigminer, SimRVPedigree, sinew, siteymlgen, smapr, SMMT, smurf, solrium, sotkanet, sparsenetgls, spdynmod, SpidermiR, spsurv, SSP, StarBioTrek, STATegRa, StructuralVariantAnnotation, SurfaceTortoise, taxa, taxizedb, taxlist, TCGAbiolinksGUI, tcpl, tcR, Tejapi, testthis, textfeatures, tidyHeatmap, tidyMicro, TimeProjection, timetk, tmt, traits, transite, urlshorteneR, usethis, vcr, vdiffr, vdiffr, vegtable, viafr, Visualize.CRAN.Downloads, vortexR, waddR, wdpar, worrms, wrswoR, WufooR, xoi, ymlthis, zzlite

Linking:

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