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
vignette is an R jargon for documentation. try ?vignette. Not all packages come with vignettes. You may want to install a package and go to the installed directory to see if any examples are given for the same. HTH Raghu On Mon, Jul 26, 2010 at 12:56 PM, alaios [via R] < ml-node+2302242-1733300369-309606@n4.nabble.com<ml-node%2B2302242-1733300369-309606@n4.nabble.com>> 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 > > ______________________________________________ > [hidden email] <http://user/SendEmail.jtp?type=node&node=2302242&i=0>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. > > > ------------------------------ > View message @ > http://r.789695.n4.nabble.com/what-is-a-vignette-tp2302242p2302242.html > To start a new topic under R help, email > ml-node+789696-608741344-309606@n4.nabble.com<ml-node%2B789696-608741344-309606@n4.nabble.com> > To unsubscribe from R help, click here< (link removed) >. > > >-- 'Raghu' -- View this message in context: http://r.789695.n4.nabble.com/what-is-a-vignette-tp2302242p2302258.html Sent from the R help mailing list archive at Nabble.com. [[alternative HTML version deleted]]
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 > > ______________________________________________ > R-help at r-project.org 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
Please type RSiteSearch("vignette") in the console and you will see
what
vignette is. I am also new to R and only learnt this week that you could
always find out about these complicated jargon by typing
RSiteSearch("...") where ... would be whatever you want to search,
thanks to the discussions on the R list.
Lexi
-----Original Message-----
From: r-help-bounces at r-project.org [mailto:r-help-bounces at r-project.org]
On Behalf Of Alaios
Sent: Monday, July 26, 2010 1:55 PM
To: r-help at r-project.org
Subject: [R] what is a vignette?
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
______________________________________________
R-help at r-project.org 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.
DISCLAIMER:\ Sample Disclaimer added in a VBScript.\ ...{{dropped:3}}