[R-pkg-devel] Nickname allowed in description when submitting to CRAN?

[Ivan Krylov]

В Sun, 25 Jun 2023 06:30:39 +0000
Bernd.Gruber <Bernd.Gruber using canberra.edu.au> пишет:

> I read in some stackexchange answers that it is possible to add the
> keyword
> 
> Nickname:
> 
> to the description file. It works fine when I check the package but
> winbuilder comes back with a note:
> 
> Unknown, possibly misspelled, fields in DESCRIPTION:
>   'Nickname'
> 
> So the question is, is there a way to have a nickname for a version
> of an R package and if so, how would that be done.

I'm afraid it's not exactly documented (and therefore may be subject to
change), but this NOTE is currently produced for every DESCRIPTION field
unless it's mentioned in tools:::.get_standard_DESCRIPTION_fields() or
starts with a number of prefixes (such as X-CRAN, X-schema.org,
Repository/R-Forge, VCS/, and Config/).

I see "Revision" in the list of standard DESCRIPTION fields.
Conveniently, it doesn't seem to be used by base R packages. Would it
be acceptable to use "Revision" instead of "Nickname"?

An alternative option would be to file a wishlist ticket asking for
"Nickname" to be added to the list, but then your package will have to
wait until that change propagates to the next release of R.

-- 
Best regards,
Ivan