From ggrothendieck at gmail.com  Thu Mar  5 03:03:37 2009
From: ggrothendieck at gmail.com (Gabor Grothendieck)
Date: Wed, 4 Mar 2009 21:03:37 -0500
Subject: [Rd] Two documentation questions
In-Reply-To: <200903050138.n251c6qr006942@yacko.mayo.edu>
References: <200903050138.n251c6qr006942@yacko.mayo.edu>
Message-ID: <971536df0903041803u1644bf52m62b1d6dd76473d7b@mail.gmail.com>

Perhaps you could just place the output in comments.

print(5) # 5

head(BOD, 2)
#   Time demand
# 1    1    8.3
# 2    2   10.3

On Wed, Mar 4, 2009 at 8:38 PM, Terry Therneau <therneau at mayo.edu> wrote:
> ?1. I often like to put bits of the output into the manual pages. ?(We can
> have a discussion of the value of this elsewhere -- I think it is sometimes
> a good thing.)
> ?In R I need to surround these with \dontrun{} for the sake of the tester,
> which is fine. ?But the printed output contains
> ? ? ? ?## Not run
> and
> ? ? ? ?## End (not run)
>
> comments, which defeats the purpose of the lines by breaking them off from
> the their context. ?How do I turn these off? ?For printing \dontrun should
> be a no-op. ?Or at least I should have the option of making it so -- I'm rather
> opinionated about the format of things I prepare for teaching purposes.
> You can assume medium Tex skills in answering; my book is in Latex but I
> don't create my own formats.
>
> 2. In the pdf for the survival package, or at least the one generated by R CMD
> check, the entries are in a random order. ?Can I fix this? ?It makes reading
> the document to look for errors rather challenging. ?(That is, when I'm
> looking at a particular Rd file, and want to see what it turned out to be.)
>
> ? Terry Therneau
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



[Rd] Two documentation questions
Gabor Grothendieck