jmaspons / osmapir Goto Github PK

Last sync wiki version: 2585039 - diff current

• NEW osm_get_objects: osm_fetch_objects, osm_read_object, osm_full_object, osm_version_object

• NEW osm_get_user_details: osm_details_user, osm_details_users

• Unify osmchange_create, osmchange_delete and osmchange_modify?

• Rename files with private function for OSM API calls osm_* -> osmapi_*

Checks for osmapiR (v0.0.0.22)

git hash: b3aa78ee

• ✔️ Package name is available
• ✔️ has a 'codemeta.json' file.
• ✔️ has a 'contributing' file.
• ✖️ The following functions have no documented return values: [osm_delete_note, osm_hide_comment_changeset_discussion, osm_redaction_object]
• ✔️ uses 'roxygen2'.
• ✔️ 'DESCRIPTION' has a URL field.
• ✔️ 'DESCRIPTION' has a BugReports field.
• ✔️ Package has at least one HTML vignette
• ✖️ These functions do not have examples: [osm_create_gpx, osm_delete_gpx, osm_delete_note, osm_hide_comment_changeset_discussion, osm_redaction_object, osm_update_gpx].
• ✔️ Package has continuous integration checks.
• ✔️ Package coverage is 84.7%.
• ✔️ R CMD check found no errors.
• ✔️ R CMD check found no warnings.

Important: All failing checks above must be addressed prior to proceeding

Package License: GPL (>= 3)

Error in httptest2::with_mock_dir nealrichardson/httptest2#35
Works with simplify = FALSE (e.g. https://github.com/jmaspons/osmapiR/blob/main/tests/testthat/mock_set_prefs_user/osm.org/api/0.6/user/preferences-eb5ee0-PUT.R)

Reduce clashes with tags in wide format and match osmdata.

See:

• https://taginfo.openstreetmap.org/keys/type
• https://taginfo.openstreetmap.org/keys/osm_type
• https://taginfo.openstreetmap.org/keys/id
• https://taginfo.openstreetmap.org/keys/osm_id

Hi @jmaspons, congratulations on submitting this package to rOpenSci! It'll be a great addition to the OSM ecosystem there. I was trying to debug why checks for this package didn't appear, and discovered that the following lines refer to functions from osmdata, yet that package is neither imported nor suggested here:

These become errors because the rOpenSci systems runs roxygen2::roxygenise() or the equivalent devtools::document(), while those are not called in standard rcmdcheck, which is why those checks all pass. roxygen2 has to then parse the function name from the package, which requires the package to be installed. My preferred way around this is to replace, for example,

The function [osmdata::opq()]

with

The \pkg{osmdata} function opq()

The \pkg{...} tag is resolved by roxygen simply by examining available.packages(), regardless of whether or not they are installed, and so does not error. The function name is then just plain code that requires no interpretation. When you've fixed those, feel free to ping the bot to run checks again.