[R] List of tags in roxygen and use for S4 classes?

[Rainer M Krug]

On Fri, Sep 4, 2009 at 4:47 PM, Bernd Bischl<bernd_bischl at gmx.net> wrote:
> 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".

Thanks a lot for the info.

> - 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.

I agree completely.

>.
> So it's worth a try but expect some obstacles. There's also a roxygen devel
> list, where you could go with questions.

Good idea. I will post there with questions.

> I got some S4 examples from one of the recent roxygen talks, If you want
> them I could forward those.

Yes - that would be great.  It would give me an idea abut the tags.

Cheers,

Rainer

>
> Bernd
>
>
>



-- 
Rainer M. Krug, Centre of Excellence for Invasion Biology,
Stellenbosch University, South Africa