pdil / usmapdata Goto Github PK

Builds are failing due to the lack of documentation for the regions parameter of centroid_labels:

Warning:   Undocumented arguments in documentation object 'centroid_labels'
Execution halted
    ‘regions’
  
  Functions with \usage entries need to have the appropriate \alias
  entries, and all their arguments documented.
  The \usage entries must correspond to syntactically valid R code.
  See chapter ‘Writing R documentation files’ in the ‘Writing R
  Extensions’ manual.

The following workflows and actions are affected:

• lintr
  • actions/checkout@v3 ➡️ @v4
  • github/codeql-action/upload-sarif@v2 ➡️ @v3 (CodeQL deprecation)
• R-cmd-check
  • actions/checkout@v3 ➡️ @v4
• test-coverage
  • actions/checkout@v3 ➡️ @v4

actions/checkout@v3 is due to the Node.js 16 deprecation

See also related change: #23

Currently the process of updating shapefiles is only semi-automated. While there are scripts in the data-raw folder that will convert US Census Bureau shapefiles into data frames readable by usmapdata, it is still a process that requires manual checking of the census website and downloading the appropriate files.

In order to provide for more timely updates to shapefiles as new ones are released, it would be beneficial to create (or attempt to create) a fully automated process that can check the relevant website(s), download the files, and create the csv data files automatically.

GitHub Actions workflows can be used to facilitate this:

1. Scheduled monthly task to check US Census Bureau website for shapefile updates*
2. If update exists, download required files*
3. Process files and convert them to .csv files that are readable by usmapdata
4. Open a pull request with the changes and new files (possibly send a notification using Pushover)
5. Project maintainer(s) review the changes and ensure everything is correct, works, and tests pass
6. Changes are made manually to resolve any issues and then the pull request is merged

*Monitoring and download can be done with either shell, python, or R scripts - whichever is more ergonomic for the given task

Function and documentation were copied over straight from usmap package so some references are either broken or don't make sense

The update-map-data workflow is currently using actions/setup-python@v4. This should be updated to @v5 to resolve this warning:

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/setup-python@v4. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

Replace with "map data files" as this is more general in case the underlying files change from shapefiles in the future (also it sometimes triggers a spelling error in R CMD check).

As part of this, check instances of this word in the documentation to see if "map data files" is more applicable or if "shapefiles" really is the best word to use.