Boshnakov
Cc: Viechtbauer, Wolfgang (SP); r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] Require -package.Rd?
On Tue, Sep 24, 2019 at 8:07 AM Georgi Boshnakov
wrote:
>
> It is worth noting that
>
> help(package="")
>
> shows file -package.Rd, while
>
&g
On Tue, Sep 24, 2019 at 8:07 AM Georgi Boshnakov
wrote:
>
> It is worth noting that
>
> help(package="")
>
> shows file -package.Rd, while
>
> help()
>
> shows topic "package".
>
> Topic -package.Rd is also printed at the top of the pdf manual,
> while package.Rd follows the alphabetical
Georgi Boshnakov
-Original Message-
From: R-package-devel [mailto:r-package-devel-boun...@r-project.org] On Behalf
Of Viechtbauer, Wolfgang (SP)
Sent: 24 September 2019 13:16
To: r-package-devel@r-project.org
Subject: [R-pkg-devel] Require -package.Rd?
Hi All,
When starting to work wit
I would be in favour. I actually used R for several years before figuring
out that the vignette was usually where the useful introduction was. Until
then I was like “R help is way too technical”
On Tue, 24 Sep 2019 at 13:26, Joris Meys wrote:
> Dear Dr. Vichtbauer,
>
> I'm not a CRAN member,
ber 2019 13:16
To: r-package-devel@r-project.org
Subject: [R-pkg-devel] Require -package.Rd?
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(p
-Original Message-
From: Dirk Eddelbuettel [mailto:e...@debian.org]
Sent: Tuesday, 24 September, 2019 14:39
To: joris.m...@ugent.be
Cc: Viechtbauer, Wolfgang (SP); r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] Require -package.Rd?
Wolfgang, Joris,
This may not necessarily
Wolfgang, Joris,
This may not necessarily work -- see "Goodhart's Law" [1]
Once you impose something like this, (some) will skirt it with just the
minimum requirement of an (essentially) empty file. An existing set of
examples is provided by the vignettes of (at least) one developer which
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
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="")
is often not so useful -- such a listing of functions (with titles) might
