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: 6.1.1
Depends: R (≥ 3.1)
Imports: brew, commonmark, desc (≥ 1.2.0), digest, methods, pkgload (≥ 1.0.2), purrr, R6 (≥ 2.1.2), Rcpp (≥ 0.11.0), stringi, stringr (≥ 1.0.0), utils, xml2
LinkingTo: Rcpp
Suggests: covr, devtools, knitr, rmarkdown, testthat (≥ 0.8.0)
Published: 2018-11-07
Author: Hadley Wickham [aut, cre, cph], Peter Danenberg [aut, cph], Manuel Eugster [aut, cph], RStudio [cph]
Maintainer: Hadley Wickham <hadley at rstudio.com>
BugReports: https://github.com/klutometis/roxygen/issues
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
URL: https://github.com/klutometis/roxygen
NeedsCompilation: yes
Materials: README NEWS
CRAN checks: roxygen2 results

Downloads:

Reference manual: roxygen2.pdf
Vignettes: Collation order
Text formatting reference sheet
Write R Documentation in Markdown
Package namespace
Generating Rd files
Rd keywords
Introduction to roxygen2
Package source: roxygen2_6.1.1.tar.gz
Windows binaries: r-devel: roxygen2_6.1.1.zip, r-release: roxygen2_6.1.1.zip, r-oldrel: roxygen2_6.1.1.zip
OS X binaries: r-release: roxygen2_6.1.1.tgz, r-oldrel: roxygen2_6.1.1.tgz
Old sources: roxygen2 archive

Reverse dependencies:

Reverse depends: miscFuncs, sqlutils
Reverse imports: aoos, cartools, DataPackageR, devtools, docstring, document, exampletestr, golem, link2GI, populationPDXdesign, Rd2roxygen, redland, RSuite, uavRmp, wtss, zoon
Reverse suggests: alfr, analogsea, anomalize, arrow, aRxiv, autoshiny, autovarCore, aweek, BAS, BayesianTools, bdclean, bikedata, bold, bomrang, broman, bunchr, camsRad, ccafs, charlatan, chromer, circumplex, civis, clustermq, codebook, CompGLM, CornerstoneR, cowsay, crminer, CrossClustering, datadr, deisotoper, denvax, DescribeDisplay, df2json, discreteRV, dodgr, doremi, dotCall64, dr4pl, DrImpute, DSAIDE, dynr, earlyR, ecd, edgarWebR, elastic, epiflows, epitrix, etseed, eurostat, expp, factory, fakemake, FedData, felp, fgeo.tool, flippant, forecastHybrid, fulltext, gapfill, geometa, geonapi, geonetwork, geoops, geosapi, geozoo, getCRUCLdata, getlandsat, GGally, ggenealogy, gitlabr, googleAuthR, googledrive, gppm, gqlr, GSODR, h5, HiClimR, hoardr, hopit, httping, icd, ifaTools, iheatmapr, inlmisc, intergraph, IRkernel, isdparser, jaod, jiebaR, jqr, JSmediation, jubilee, JuniperKernel, knitrBootstrap, konfound, latticeDensity, lawn, lcc, ldhmm, learnrbook, lineup, lmQCM, logger, loose.rock, makeParallel, mapsRinteractive, mase, matrixNormal, MazamaCoreUtils, mc.heterogeneity, mgarchBEKK, micompr, miniCRAN, mizer, Momocs, morpheus, mrbayes, mregions, mtconnectR, multipanelfigure, nat.utils, negenes, nima, nlmeU, nscancor, nseval, nsprcomp, oai, openadds, OpenMx, oppr, optimParallel, optmatch, originr, osmdata, osmplotr, paleobioDB, pcIRT, PerseusR, photobiology, pkgmaker, pleiades, pnn, popEpi, PP, PPforest, prioritizr, prioritizrdata, projections, protoclass, pwrRasch, pxweb, qsort, qtlcharts, Quandl, questionr, R4CouchDB, radiomics, ragtop, randomsearch, rappdirs, raptr, rAvis, rbgm, rbhl, rbison, rbokeh, rbundler, Rclean, rClinicalCodes, rcoreoa, RcppProgress, rcrossref, RCzechia, rddapp, rdpla, rdtLite, recexcavAAR, refimpact, rerddap, rerf, rex, rif, riskyr, ritis, RItools, rMouse, rnoaa, roadoi, rpcdsearch, rpf, RQEntangle, rredlist, rsdmx, RSocrata, rstanarm, rstantools, rYoutheria, scholar, scriptexec, SDMtune, sdmvspecies, seaaroundus, SimRVPedigree, sinew, smapr, smurf, solrium, sotkanet, spdynmod, spocc, SurfaceTortoise, taxa, taxize, taxizedb, tcpl, tcR, Tejapi, testthis, textfeatures, TimeProjection, tmt, traits, unikn, urlshorteneR, usethis, vdiffr, viafr, vortexR, wdpar, webmockr, wikitaxa, worrms, wrswoR, WufooR, xoi

Linking:

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