R Hackathon 1/R Vignette HowTo

From Phyloinformatics
Revision as of 15:41, 18 November 2007 by Bbolker (talk) (creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

R vignettes: Sweave

(I just wrote a whole bunch of stuff about vignettes and Sweave and then clicked away to check something and lost about five paragraphs of work. How frustrating!)

Very briefly, then:

  • R has two kinds of documentation: manual pages and vignettes. Manual pages are typically brief reminders -- they can (and should) contain examples, but don't give much context and are rarely useful when starting from scratch.
  • vignettes are written in Sweave, which is itself based on LaTeX (but see below).