index.md

title	layout	output
R Documentation Task Force	page	html_document self_contained

Overview

The R Documentation Task Force is an R Consortium Infrastructure Steering Committee supported project to design a new documentation infrastructure for R.

The advantages of this new documentation system are:

1. Documentation can be created in many different methods and converted between them.
2. Documentation can be generated dynamically for functions returned as values from other functions.
3. Documentation can be de-coupled from the package system.

Packages

Tools and utilities for dealing with parse data. It includes tools for extracting parse data cleaner than what is obtained from the utils::getParseData function. It also includes utilities for subsetting the parse data and identifying different components and structures.

A general purpose package pkgcond facilitates the creation of errors, warnings, and messages (collectively called signals or conditions) that are more informative than the base versions.

Signals can be created through pkg_error(), pkg_warning() and pkg_message(). When these are used a scope is computed and used to create errors, warnings and signals, respectively, with classes set to the combinations of the scope. The scope, while is could be set explicitly, infers where the condition is created, and will typically include the function call and package name.

Postlogic add postfix logic opperators %if% and %unless% for convenience. This is used in other RDTF packages primarily for conditioning verbose messages.

The testextra package provides the support for embedding testthat compatible tests in source code through special testing blocks.

if(FALSE){#@testing An optional description
    # place tests in a block such as this and they will be extracted
    # to the ./tests/testthat folder when extract_tests() is run.
}

The Rd package extends the base utilities in the tools and utils package to facilitate creation, checking and manipulation of R documentation (Rd) objects in code. It is similar in functio and usage to the htmltools package.

The extendedRef package adds private variables, static variables, and static methods to reference classes.

documentation

The core of the new documentation infrastructure. This package contains the classes for documentation encapsulation as well as methods for creation of documentation objects and formatting. While the class system is maturing, what is and is not included in this package versus independent packages is still in flux.