Even more documentation
Making a package manual
To create a PDF or DVI fromat manual file from the Rd files of our package use R CMD Rd2dvi, and possibly dvipdf. The eaisest route is to simply go to the directory below our package source and enter a cmd like:
| R CMD Rd2dvi --pdf --title="The bio3d Package" bio3d |
where "bio3d" is the name of my package directory. If you use the --no-clean option a .RDsomething dir containg intermideat files will remain resident in your cwd. These are the guys to edit if you are so motivated.
Making a Package Vignette
A package vignette is an Sweave file that illustrates the use of the package. Because it is Sweave, it is non-bogus. The code actually works. We know it works because it worked to produce the LaTeX output!
Write a sweave latex file then run sweave on it
| Sweave("bio3d_vignette.Rnw") |
then run latex
| pdflatex bio3d_vignette.txt |
Current bio3d vignette (not finished)
Here is the Rwn file and output PDF
http://bio3d.pbwiki.com/f/bio3d_vignette.pdf
http://bio3d.pbwiki.com/f/bio3d_vignette.Rnw - over disk quota on wiki (e-mail me for this)
Comments (0)
You don't have permission to comment on this page.