Re: [R] Package docs for CRAN

[Tuszynski, Jaroslaw W.]

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: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] 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@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

__
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

Re: [R] Package docs for CRAN

[Gabor Grothendieck]

If your package is called mypkg you could create a mypkg-package.Rd
file.  e.g.

library(dyn)
library(help = dyn) # note that mypkg-package is listed
package?dyn
?dyn-package   # same

and you could add one or more vignettes, e.g.

library(zoo)
library(help = zoo) # note that the 2 vignettes are listed at end
vignette(zoo)


On 4/30/06, William Asquith [EMAIL PROTECTED] wrote:
 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@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


__
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