Re: [Rd] why is \alias{anRpackage} not mandatory?

From: Thomas Petzoldt <Thomas.Petzoldt_at_tu-dresden.de>
Date: Mon, 06 Oct 2008 15:42:13 +0200

Dear Hadley,

thank you very much for your comments.

hadley wickham wrote:
>>> - there are lots of packages without one, so this would create a lot of
>>> work for people to add them.
>> No, I don't think that this is too much work. Positively speaking, it's one
>> small contribution to bring more light into the exponentially growing
>> haystack.
>
> It may not be much work for you, but I find any additional
> requirements to the package format to be a real pain. I have ~10
> packages on CRAN and having to go through and add this extra
> information all at once is a big hassle. R releases tend to happen in
> the middle of the US academic semester when I have a lot of other
> things on my plate.

O.K., but the discussion with Duncan shows:

> Additionally, I find that rdoc is the wrong format for lengthy
> explanation and exposition - a pdf is much better - and I think that
> the packages already have a abstract: the description field in
> DESCRIPTION.
o.k., but abstract may be (technically) in the wrong format and does not point to the other relevant parts of the package documentation.

> The main problem with vignettes at the moment is that
> they must be sweave, a format which I don't really like. I wish I
> could supply my own pdf + R code file produced using whatever tools I
> choose.
>
 > Hadley

I like Sweave, and it is also possible to include your own PDFs and R files and then to reference them in anRpackage.Rd.

Thomas P.



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Mon 06 Oct 2008 - 13:55:07 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Mon 06 Oct 2008 - 14:30:18 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive