search

inbo / checklist

An R package for checking R packages and R code
https://inbo.github.io/checklist
GNU General Public License v3.0
16 stars 2 forks source link

filename convention error about internal package data R/sysdata.rda #62

Closed hansvancalster closed 3 years ago

hansvancalster commented 3 years ago

According to https://r-pkgs.org/data.html#data-sysdata internal package data are best saved as R/sysdata.rda. The current version of checklist returns a filename convention error:

filename conventions: 1 error
----------------------------------------------------------------------------------------------------------------
 R file requires extension with upper case R.
Fails: `R/sysdata.rda`

I tried renaming R/sysdata.rda to R/sysdata.Rda but that doesn't work:

√  checking DESCRIPTION meta-information ... 
-  excluding invalid files (1.7s)
   Subdirectory 'R' contains invalid file names:
     'sysdata.Rda'

So probably R/sysdata.rda should be added to the exceptions?

The official documentation also mentions this exception in addition to one other: 

Two exceptions are allowed: if the R subdirectory contains a file sysdata.rda (a saved image of one or more R objects: please use suitable compression as suggested by tools::resaveRdaFiles, and see also the ‘SysDataCompression’ DESCRIPTION field.) this will be lazy-loaded into the namespace environment – this is intended for system datasets that are not intended to be user-accessible via data. Also, files ending in ‘.in’ will be allowed in the R directory to allow a configure script to generate suitable files.