This is exactly what I was looking for. Thanks so much! Sincerely, Erin
On Fri, Mar 6, 2015 at 3:50 PM, Duncan Murdoch <[email protected]> wrote: > On 06/03/2015 1:25 PM, Erin Hodgess wrote: > > Hello! > > > > I've built several packages before, but am now building a new package and > > would like to have a vignette to go with it. I will be using knitr for > it. > > > > My question, please: could someone recommend a good reference on the > > content-type material itself for the vignette, please? > > I don't know a reference to recommend, but when I am trying out a new > package, the first thing I look for is a vignette to give a package > overview. It should say what the package is for, and demonstrate (at > least) the major functions. If I don't find a vignette, I deduct 5 > points ;-). > > After the package overview, you might also have vignettes that discuss > particular technical issues. > > If you have published a paper about your package in the R Journal or > JSS, including a copy as a vignette is a reasonable thing to do. (Of > course, as the package evolves, the paper might become obsolete; then > you have a problem: update it, or just declare it of historical interest?) > > Duncan Murdoch > > -- Erin Hodgess Associate Professor Department of Mathematical and Statistics University of Houston - Downtown mailto: [email protected] [[alternative HTML version deleted]] ______________________________________________ [email protected] mailing list -- To UNSUBSCRIBE and more, see 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.
