roxygen2 v6.0.1

by Hadley Wickham

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

Readme

roxygen2

Build Status AppVeyor Build Status CRAN_Status_Badge Coverage Status

all' hileth', Hephaiste; didou d'areten te kai olbon.* --Homer, 7th century BCE

Why use roxygen2?

The premise of roxygen2 is simple: describe your functions in comments next to their definitions and roxygen2 will process your source code and comments to produce Rd files in the man/ directory. Here's a simple example from the stringr package:

#' The length of a string (in characters).
#'
#' @param string input character vector
#' @return numeric vector giving number of characters in each element of the
#'   character vector.  Missing strings have missing length.
#' @seealso \code{\link{nchar}} which this function wraps
#' @export
#' @examples
#' str_length(letters)
#' str_length(c("i", "like", "programming", NA))
str_length <- function(string) {
  string <- check_string(string)

  nc <- nchar(string, allowNA = TRUE)
  is.na(nc) <- is.na(string)
  nc
}

When you roxygenise() (or devtools::document()) your package these comments will be automatically transformed to the Rd file you need to pass R CMD check:

\name{str_length}
\alias{str_length}
\title{The length of a string (in characters).}
\usage{str_length(string)}
\arguments{
  \item{string}{input character vector}
}
\description{
The length of a string (in characters).
}
\seealso{\code{\link{nchar}} which this function wraps}
\value{
  numeric vector giving number of characters in each element of the
  character vector.  Missings string have missing length.
}
\examples{
str_length(letters)
str_length(c("i", "like", "programming", NA))
}

Installation

To get the current released version from CRAN:

install.packages("roxygen2")

To get the current development version from github:

# install.packages("devtools")
devtools::install_github("klutometis/roxygen")

Running

Roxygen does a live analysis of your source code: it loads all the code in your package, so it can create documentation using values in an R environment, not just source code. However, simulating package loading is rather tricky to do in general, so there are two ways to do it with roxygen:

  • roxygen2::roxygenise() just sources all files in the R/ directory

  • devtools::document() sources all files in the R/ directory, compiles source code in the src/ directory, loads data in the data/ directory and generally does an accurate job of simulating package loading.

If you have a simple package, you can use roxygenise(), but for anything more complicated, I recommend that you use document().

Roclets

roxygen2 comes with four roclets, tools for parsing your source code and producing files useful for documenting your package:

  • collate_roclet: allows you to add @include directives to ensure that files are loaded in the order they are needed

  • namespace_roclet: creates your NAMESPACE automatically. 95% of the time all you need to do is label functions, methods and classes that you want to export with the @export tag

  • rd_roclet: produces Rd files by inspecting both function definitions and roxygen2 comments in the source code

  • vignette_roclet: builds vignettes using tools::buildVignette().

By default, roxygenise will run the first three, but you can choose which ones to run using the roclet parameter, or field Roxygen in your DESCRIPTION:

Roxygen: list(roclets = c("rd", "collate"))

  • Hail, Hephaistos! Grant skill and weal.

Functions in roxygen2

Name Description
escape_rd_for_md Escape Rd markup, to avoid interpreting it as markdown
roclet_find Create a roclet from a string.
roclet Build a new roclet.
roxygen2-package roxygen2: In-Line Documentation for R
roxy_tag Parsing tags.
source_package Source all files in a package.
roxygenize Process a package with the Rd, namespace and collate roclets.
update_collate Update Collate field in DESCRIPTION.
vignette_roclet Re-build outdated vignettes.
markdown-test Dummy page to test roxygen's markdown formatting
namespace_roclet Roclet: make NAMESPACE.
double_escape_md Escape % and \$ and \_ once more, because commonmark removes the escaping. We do this everywhere currently.
rd_roclet Roclet: make Rd files.
is_s3_generic Determine if a function is an S3 generic or S3 method.
object_format Default format for data
load_options Load options from DESCRIPTION.
roc_proc_text Process roclet on string and capture results.
object Constructors for S3 object to represent R objects.
No Results!

Details

License GPL (>= 2)
VignetteBuilder knitr
LinkingTo Rcpp
RoxygenNote 6.0.1
URL https://github.com/klutometis/roxygen
BugReports https://github.com/klutometis/roxygen/issues
NeedsCompilation yes
Packaged 2017-02-06 14:33:02 UTC; hadley
Repository CRAN
Date/Publication 2017-02-06 16:37:05

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/roxygen2)](http://www.rdocumentation.org/packages/roxygen2)