[prev in list] [next in list] [prev in thread] [next in thread] 

List:       r-devel
Subject:    [Rd] S4: Documenting several fields at once
From:       Christophe Genolini <cgenolin () u-paris10 ! fr>
Date:       2010-03-22 18:16:45
Message-ID: 4BA7B40D.2070501 () u-paris10 ! fr
[Download RAW message or body]

Hi all,
I defined an S4 object in which there is a lot of fields that have very 
similar names and purposes.
--- 8< ----------
setClass(
   Class="foo",
   representation=representation(
      c2="list",
      c3="list",
      c4="list",
      c5="list",
      c6="list",
      c7="list",
        ...
      c26="list"
  )
)
--- 8< ----------

In the documentation (Rd file), is there a way to describe only one of 
the field, then say all the other work the same way?

--- 8< ----------
\section{Slots}{
  \describe{
    \item{\code{c2}}{list of Clustering with 2 clusters.}
    \item{\code{c3}}{list of Clustering with 3 clusters.}
    \item{\code{c4} ... \code{c26}}{list of Clustering with 4, ..., 26 
clusters.}
  }
}
--- 8< ---------

Thanks

Christophe

______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
[prev in list] [next in list] [prev in thread] [next in thread]