[R-pkg-devel] note about mispelled words

Henrik Bengtsson henr|k@bengt@@on @end|ng |rom gm@||@com
Tue Mar 17 16:41:39 CET 2020


You can single quote them to avoid them being spell checked, e.g. ...
using methods of 'Kruskall' and 'Brainerd'.  This is a common and
accepted practice.

This is hinted at in "Writing R Extensions" (e.g. help.start());

The mandatory ‘Description’ field should give a comprehensive
description of what the package does. One can use several (complete)
sentences, but only one paragraph. It should be intelligible to all
the intended readership (e.g. for a CRAN package to all CRAN users).
It is good practice not to start with the package name, ‘This package’
or similar. As with the ‘Title’ field, double quotes should be used
for quotations (including titles of books and articles), and single
quotes for non-English usage, including names of other packages and
external software. This field should also be used for explaining the
package name if necessary. URLs should be enclosed in angle brackets,
e.g. ‘<https://www.r-project.org>’: see also Specifying URLs.

/Henrik

On Tue, Mar 17, 2020 at 8:30 AM Gianmarco Alberti
<gianmarcoalberti using gmail.com> wrote:
>
> Hello,
> I am checking a package of mine, and I got only 1 note regarding possibly misspelled words in the DESCRIPTION.
>
> The issue I am facing is that those 6 words are not actually misspelled, being either first or last names of individuals (actually, statistician; e.g., Kruskall, Brainerd).
>
> Shall I have to do something (removing those; which does not make sense), or upon submitting my new version of the package there is a way to make clear that that note can be ignored?
>
> By the way, those names were already there in earlier versions of the package and no note cropped out in those occasions.
>
> Thank you
> Best
> GmA
>
> ************************************************
> Dr Gianmarco Alberti (PhD Udine)
> Lecturer in Spatial Forensics
> Coordinator of the BA course in Criminology
> Department of Criminology
> Faculty for Social Wellbeing
> Room 332, Humanities B (FEMA)
> University of Malta, Msida, Malta (Europe) - MSD 2080
> tel +356 2340 3718
>
> Academic profiles
> https://www.researchgate.net/profile/Gianmarco_Alberti4
> https://malta.academia.edu/GianmarcoAlberti
>
> Google Scholar profile
> https://scholar.google.com/citations?user=tFrJKQ0AAAAJ&hl=en
>
> Correspondence Analysis website
> http://cainarchaeology.weebly.com/
>
> R packages on CRAN:
> CAinterprTools
> https://cran.r-project.org/web/packages/CAinterprTools/index.html
>
> GmAMisc
> https://cran.r-project.org/package=GmAMisc
>
> movecost
> https://cran.r-project.org/web/packages/movecost/index.html
> ************************************************
>
>         [[alternative HTML version deleted]]
>
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel



More information about the R-package-devel mailing list