Dear Dr. Vichtbauer, I'm not a CRAN member, but I personally think this is a sensible requirement. I try to include those in every package myself, even if it's only to direct people to a vignette.
That said, I do look for vignettes first when I encounter an unfamiliar package actually. That format gives more possibilities for giving a good introduction to the package imho. My humble 2 cents Cheers Joris On Tue, Sep 24, 2019 at 2:17 PM Viechtbauer, Wolfgang (SP) < wolfgang.viechtba...@maastrichtuniversity.nl> wrote: > Hi All, > > When starting to work with an unfamiliar package, one might typically look > for vignettes, a paper/book accompanying the package, a package website, > and of course the help files themselves, but > > help(package="<package>") > > is often not so useful -- such a listing of functions (with titles) might > not clarify what the main 'workhorses' of the package are and how to get > started. Personally, the first thing I do is try: > > help(<package>) > > in the hopes that the package author(s) have created a > <package>-package.Rd file to get new users started (or to point them to > appropriate places to get going). In my experience, if such a package help > file is available, it is tremendously useful. > > Unfortunately, many packages do not provide a <package>-package.Rd file. I > am curious how others and CRAN members would feel about making this a > requirement (not retrospectively, but at least for new / resubmissions). > > Best, > Wolfgang > > ______________________________________________ > R-package-devel@r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-package-devel > -- Joris Meys Statistical consultant Department of Data Analysis and Mathematical Modelling Ghent University Coupure Links 653, B-9000 Gent (Belgium) <https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g> tel: +32 (0)9 264 61 79 ----------- Biowiskundedagen 2017-2018 http://www.biowiskundedagen.ugent.be/ ------------------------------- Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php [[alternative HTML version deleted]] ______________________________________________ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel