Alex, Vignettes are optional supplemental documentation. That is, they are in addition to the required boilerplate documentation for R functions and datasets. Vignettes are written in the spirit of sharing knowledge, and assisting new users in learning the purpose and use of a package.
Maybe the best place to start is simply to read one, or a few. The `zoo` package has a few, for example here: http://cran.r-project.org/web/packages/zoo/index.html The technical details of vignettes, and how to write one are contained in the `Writing R Extensions` manual: http://cran.r-project.org/manuals.html -Matt On Mon, 2010-07-26 at 07:55 -0400, Alaios wrote: > I am trying to find a simple R guide that explain what a vignette is but so > far > I didnt make any progress. I tried to search inside R's built in help.start() > but it only returns results how to see vignettes. > > So could you please tell me what a vignette is and if you can also could you > give some simple guide that I can always use to read about these things? > > Best Regards > Alex > > ______________________________________________ > [email protected] mailing list > https://stat.ethz.ch/mailman/listinfo/r-help > PLEASE do read the posting guide http://www.R-project.org/posting-guide.html > and provide commented, minimal, self-contained, reproducible code. -- Matthew S. Shotwell Graduate Student Division of Biostatistics and Epidemiology Medical University of South Carolina ______________________________________________ [email protected] mailing list https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
