[R] Short cut for documenting arguments in Rd file

Frank E Harrell Jr f.harrell at Vanderbilt.Edu
Tue Feb 23 05:18:22 CET 2010


The following construct in Rd files has always been accepted by R:

\arguments{
   \item{formula}{}
   \item{family}{}
   \item{data}{}
   \item{weights}{}
   \item{subset}{}
   \item{na.action}{}
   \item{start}{}
   \item{offset}{}
   \item{control}{}
   \item{model}{}
   \item{method}{}
   \item{x}{}
   \item{y}{}
   \item{contrasts}{see \code{\link{glm}}}
}

This is for a series of arguments that are passed through to glm.  The 
development version of R will not let this pass, giving a warning that 
there are argument items with no descriptions.  Does anyone know of a 
workaround?  I would not like to duplicate a lot of documentation that 
is in the help file for glm.

Thanks
Frank
-- 
Frank E Harrell Jr   Professor and Chairman        School of Medicine
                      Department of Biostatistics   Vanderbilt University



More information about the R-help mailing list