[R] Sd2Rd Hangup

Thomas Lumley tlumley at u.washington.edu
Tue Jun 26 17:41:29 CEST 2001

On Tue, 26 Jun 2001, Bartz, Kevin wrote:

> I've been converting a number of .sgml S-documentation filed to .Rd format
> and a few persistent complications--all involving the documentation's
> examples--have arisen every time I issue the standard R CMD check to prepare
> my project for building. The impression I get is that the check script
> simply tries to execute every R command in the included documentation's
> example{ } sections. But since Sd2Rd essentially dumps an S-documentation
> file's example contents into the new .Rd file, formatting problems crop up.

Indeed. And not just formatting problems.

S has never enforced a policy on whether examples should be executable
source or session transcripts (though the former seems much more common),
or on whether executable source actually has to run, so the format doesn't
let you specify, and it would be hard for a program to guess.

R does enforce a policy, as you have found. However, in converting other
people's S help files I have found editing the content of the examples to
be more work than editing the format -- S examples don't have to work, but
R examples do.


Thomas Lumley			Asst. Professor, Biostatistics
tlumley at u.washington.edu	University of Washington, Seattle

r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request at stat.math.ethz.ch

More information about the R-help mailing list