Re: [R] Great R documentation

From: Michael Dewey <info_at_aghmed.fsnet.co.uk>
Date: Mon 31 Jul 2006 - 22:15:26 EST

At 10:09 31/07/2006, hadley wickham wrote:
>Dear all,
>
>I'm trying to improve the documentation I provide my R packages, and
>to that end I'd like to find out what you think is great R
>documentation. I'm particularly interested in function documentation,

Hadley, I do not think any bit of function documentation, if you mean the manual page type documents, is ever that enlightening unless you already know what the function does. For me the useful documents are the more extended narrative documents.

What I find helpful is:
start with what is the aim of this document tell me what I am assumed to know first (and ideally tell me where to look if I do not)
start with an example using the defaults tell me what the output means in terms of the scientific problem tell me what action I might take when it gives me a warning (if that is predictable)
tell me about other packages with the same aim and why I should use this one tell me where to go for more information

>but great vignettes, websites or book are also of interest.
>
>What is your favourite bit of R documentation, and why?
>
>Thanks,
>
>Hadley
>
>

Michael Dewey
http://www.aghmed.fsnet.co.uk



R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. Received on Mon Jul 31 22:22:49 2006

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.1.8, at Tue 01 Aug 2006 - 00:17:07 EST.

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