[R] Package docs for CRAN

Tuszynski, Jaroslaw W. JAROSLAW.W.TUSZYNSKI at saic.com
Mon May 1 16:13:26 CEST 2006


See 
Function promptPackage() and
http://cran.r-project.org/doc/manuals/R-exts.html#Rd-format section
2.1.4 fpr writing Rd files for packages. I just did it first time for my
package caMassClass, so you can see the results in its pdf file.

Jarek Tuszynski

-----Original Message-----
From: r-help-bounces at stat.math.ethz.ch
[mailto:r-help-bounces at stat.math.ethz.ch] On Behalf Of William Asquith
Sent: Sunday, April 30, 2006 10:00 AM
To: R-Help
Subject: [R] Package docs for CRAN

CRAN et al.,

I would like to add an extented introduction or other arbitrary  
sections to my package lmomco.
I have been shipping inst/doc/Introduction.Rd. I would like to have  
this content inserted to the front of the PDF build for the CRAN. The  
R-exts.pdf seems to be a little silent on this subject? For my  
purposes, I have been doing this

R CMD Rd2dvi --pdf --title="lmomco---version X" inst/doc/ 
Introduction.Rd man/*.Rd

but I don't get the correct header (description) or the index built  
as seen in the lmomco.pdf from the CRAN.

Further, is there any point in shipping a complete PDF build of the  
docs as in inst/doc/lmomco.pdf?

Please advise on best practices for building the best docs that I  
can. . .

William

______________________________________________
R-help at 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




More information about the R-help mailing list