Hi is there a list of all roxygen tags which are available? I couldn't find them. I am asking specifically towards the use of roxygen in documenting S4 classes - is that implemented yet (i am using roxygen 0.1 from CRAN at the moment)? Thanks Rainer -- Rainer M. Krug, Centre of Excellence for Invasion Biology, Stellenbosch University, South Africa
Rainer M Krug wrote:> Hi > > is there a list of all roxygen tags which are available? I couldn't find them. > > I am asking specifically towards the use of roxygen in documenting S4 > classes - is that implemented yet (i am using roxygen 0.1 from CRAN at > the moment)? > > Thanks > > Rainer > > >I am using it do document a now rather large S4 package - with the new development version on rforge (its 0.1-1). It basically works, _but_ : - It took me quite some time to write everything "the way roxygen wants it" - Error messages are often not very informative. - Many (legal) ways to specify S4 classes / signatures will produce errors, you need to be very "verbose". - Even disregarding there are still some clear bugs left IMHO. I would also wish for a better (online) documentation, as I think the general idea of roxygen is great. So it's worth a try but expect some obstacles. There's also a roxygen devel list, where you could go with questions. I got some S4 examples from one of the recent roxygen talks, If you want them I could forward those. Bernd
On Mon, Sep 7, 2009 at 9:41 AM, Peter Danenberg<pcd at roxygen.org> wrote:>> > I would also wish for a better (online) documentation, as I think the >> > general idea of roxygen is great. >> >> I agree completely. > > Good call; the vignette is terse and outdated. Manuel and I are in the > process of preparing a paper based on our DSC talks; that should fill > in some of the details w.r.t. S4.That sounds exciting. I am really looking forward to it - because roxygen is the way to go for documenting. Rainer>-- Rainer M. Krug, Centre of Excellence for Invasion Biology, Stellenbosch University, South Africa