What tags are required in the R documentation?

Question

When documenting the R functions in myfunction.Rdand entire packages in mypackage-package.Rd, which tags are required?

By "tags" I mean things that look like \somename{}. For instance: \item{} \title{} \examples{}

+3

power May 08 '12 at 9:49

1 answer

Joshua ulrich · Accepted Answer · 2012-05-08T10:44:25+0000

This is described in Section 2.1 - The Rd Format for Writing Extensions. Look for "required".

Required sections for functions:

\name{name}
\alias{topic}
\title{title}
\description{...}
\usage{fun (arg1, arg2, ...)}
\arguments{...}

For packages:

\name{name}
\alias{topic}
\title{title}
\docType{package}