[R-pkg-devel] Help with 2 NOTES

[Ivan Krylov]

Dear Jaime Salvador,

Welcome to R-package-devel!

В Wed, 9 Oct 2024 20:42:24 +0000
Jaime Salvador <jaime.salvador using ideasybits.com> пишет:

> New submission

This one is expected for new packages.

> Possibly misspelled words in DESCRIPTION:
>   DICX (12:67)
>   RXDB (12:59)
>   Redatam (2:34, 12:40)

Wrap the abbreviations and software names into 'single quotes':
https://contributor.r-project.org/cran-cookbook/description_issues.html#formatting-software-names.
Some of the acronyms may need to be explained in the submission
comments in the CRAN web form.

I see you've tried to put the acronyms into the WORDLIST, but I think
the interface for spell-checking the package is different (see
?'aspell-utils') and involves saving vectors of words into .rds files
in .aspell and describing them in .aspell/defaults.R.

(If anything reads WORDLIST, why doesn't grep -r WORDLIST src on the R
source code show anything?)

> * checking for detritus in the temp directory ... NOTE
> 
> Found the following files/directories:
>   ‘redatam’

Some code from your package that ran during R CMD check (it's usually
examples or tests) created the file named "redatam" in the temporary
directory and didn't remove it afterwards. I'm not seeing any R code do
this, so it must be something in the libredengine DLL. Can you make it
remove its temporary files during _redatam_redatam_destroy()?

There are more serious problems not flagged by R CMD check.

Your code downloads a binary DLL during the configuration stage. What
is the license under which it is shipped? Will it work on macOS? CRAN
policy recommends including sources or downloading (and compiling on
the fly) a fixed version rather than the latest one, although I know
of exceptions for some open-source libraries.

Almost all your examples are wrapped in \dontrun{}. Generally, this is
only allowed for code that absolutely has no chance of running as
written, for example, due to a missing API key:
https://contributor.r-project.org/cran-cookbook/general_issues.html#structuring-of-examples

Your NAMESPACE contains a lot of extraneous stuff. You intend for the
user to call functions redatam.open(), redatam.query(), and so on, but
roxygen2 misinterpreted those as S3 methods and registered them for the
S3 generic redatam, which doesn't do anything and isn't properly
documented. It's best to get rid of the S3 generic and only export the
functions by name (e.g. export(redatam.open, redatam.query)) instead of
resorting to exportPattern("^[[:alpha:]]+"). Maybe it's best to just
avoid dots in the function names altogether, lest something else
misinterprets them as S3 methods.

Your "Description:" field says "you need R (>=4.0)", which is better
expressed as a separate field, "Depends: R (>= 4.0)".

-- 
Best regards,
Ivan