items in Rd file

Achim Zeileis zeileis@ci.tuwien.ac.at
Fri, 04 Oct 2002 20:45:18 +0200


"Liaw, Andy" wrote:
> 
> Dear R-devel,
> 
> I'm encountering a strange problem in a Rd file that I'm working on.  In the
> "Value" section, I have something like:
> 
> =====================
> \value{
>   An object of class \code{randomForest}, which is a list with the
>   following components:
>   \item{call}{the original call to \code{randomForest}}
>   ...
> 
>   For classification problem, the following are also included:
> 
>   \item{err.rate}{final error rate of the prediction on the input data.}
>   ...
> 
>   For regression problem, the following are included:
>   \item{mse}{mean square error: sum of squared residuals divided by
>     \code{n}.}
>   ...
> 
>   If test set is given (through the \code{xtest} or additionally
>   \code{ytest} arguments), then there is also a \code{test} component,
>   which is a list with the following components:
> 
>   \item{predicted}{predicted classes/values for the test set.}
>   ...
> 
>   Note:  The \code{forest} structure is slightly different between
>   classification and regression.
> ===============
> 
> In the resulting help page, the passages between \item{}'s all disappeared!
> Is there any way to make it work?

I think you need an 
  {\itemize \items... }
or a
   \describe{ \items.. }

Hope that helps
Z

> Thanks a lot for any tips!
> 
> Andy
> Andy I. Liaw, PhD
> Biometrics Research          Phone: (732) 594-0820
> Merck & Co., Inc.              Fax: (732) 594-1565
> P.O. Box 2000, RY84-16            Rahway, NJ 07065
> mailto:andy_liaw@merck.com
> 
> ------------------------------------------------------------------------------
> Notice: This e-mail message, together with any attachments, contains information of Merck & Co., Inc. (Whitehouse Station, New Jersey, USA) that may be confidential, proprietary copyrighted and/or legally privileged, and is intended solely for the use of the individual or entity named on this message. If you are not the intended recipient, and have received this message in error, please immediately return this by e-mail and then delete it.
> 
> ==============================================================================
> 
> -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
> r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
> Send "info", "help", or "[un]subscribe"
> (in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
> _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._