First CRAN release: 0.1.0

ropensci · Jun 27, 2024 · 845a778 · 845a778
1 parent 98b81f2
commit 845a778
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 6 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,5 +1,6 @@
 ^.*\.Rproj$
 ^CODE_OF_CONDUCT\.md$
+^CRAN-SUBMISSION$
 ^LICENSE\.md$
 ^README\.Rmd$
 ^\.Rproj\.user$
@@ -9,5 +10,6 @@
 ^\.pre-commit-config\.yaml$
 ^_pkgdown\.yml$
 ^codemeta\.json$
+^cran-comments\.md$
 ^docs$
 ^pkgdown$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Type: Package
 Package: osmapiR
 Title: 'OpenStreetMap' API
-Version: 0.0.0.40
+Version: 0.1.0
 Authors@R: c(
     person("Joan", "Maspons", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0003-2286-8727")),

diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,7 @@
+# osmapiR 0.1.0
+
+* Initial CRAN submission implementing calls to all the API endpoints.
+* Server responses are returned as R objects, xml_documents or json lists.
+* Authentication when needed with OAuth2.
+* Pagination in server responses handled internally (#20, #23 & #29).
+* Vectorization of atomic API calls (#18).
diff --git a/README.Rmd b/README.Rmd
@@ -21,6 +21,7 @@ knitr::opts_chunk$set(
 [![pkgdown](https://github.com/jmaspons/osmapiR/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/jmaspons/osmapiR/actions/workflows/pkgdown.yaml)
 [![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/osmapiR)](https://cran.r-project.org/package=osmapiR)
+[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/osmapiR)](https://cran.r-project.org/package=osmapiR)
 [![](https://badges.ropensci.org/633_status.svg)](https://github.com/ropensci/software-review/issues/633)
 <!-- badges: end -->
 
@@ -43,6 +44,12 @@ community. If you plan to do automated edits, check the
 
 ## Installation
 
+To install latest CRAN version:
+
+``` r
+install.packages("osmapiR")
+```
+
 You can install the development version of osmapiR from [GitHub](https://github.com) with:
 
 ``` r

diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ coverage](https://codecov.io/gh/jmaspons/osmapiR/branch/main/graph/badge.svg)](h
 [![Project Status:
 Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/osmapiR)](https://cran.r-project.org/package=osmapiR)
+[![CRAN
+Downloads](https://cranlogs.r-pkg.org/badges/grand-total/osmapiR)](https://cran.r-project.org/package=osmapiR)
 [![](https://badges.ropensci.org/633_status.svg)](https://github.com/ropensci/software-review/issues/633)
 <!-- badges: end -->
 
@@ -40,6 +42,12 @@ conduct](https://wiki.openstreetmap.org/wiki/Automated_Edits_code_of_conduct).
 
 ## Installation
 
+To install latest CRAN version:
+
+``` r
+install.packages("osmapiR")
+```
+
 You can install the development version of osmapiR from
 [GitHub](https://github.com) with:
 

diff --git a/codemeta.json b/codemeta.json
@@ -2,13 +2,13 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "osmapiR",
-  "description": "Interface to OpenStreetMap API for fetching and saving data from/to the OpenStreetMap database (<https://wiki.openstreetmap.org/wiki/API_v0.6>).",
-  "name": "osmapiR: OpenStreetMap API",
+  "description": "Interface to 'OpenStreetMap API' for fetching and saving data from/to the 'OpenStreetMap' database (<https://wiki.openstreetmap.org/wiki/API_v0.6>).",
+  "name": "osmapiR: 'OpenStreetMap' API",
   "relatedLink": "https://jmaspons.github.io/osmapiR/",
   "codeRepository": "https://github.com/jmaspons/osmapiR",
   "issueTracker": "https://github.com/jmaspons/osmapiR/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.0.0.40",
+  "version": "0.1.0",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -145,9 +145,10 @@
     "SystemRequirements": null
   },
   "keywords": ["openstreetmap", "OSM", "openstreetmap-api", "osmapi", "API", "osm", "r", "r-package"],
-  "fileSize": "13366.559KB",
+  "fileSize": "13368.165KB",
+  "releaseNotes": "https://github.com/jmaspons/osmapiR/blob/master/NEWS.md",
   "readme": "https://github.com/jmaspons/osmapiR/blob/main/README.md",
-  "contIntegration": ["https://github.com/jmaspons/osmapiR/actions/workflows/R-CMD-check.yaml", "https://codecov.io/gh/jmaspons/osmapiR", "https://github.com/jmaspons/osmapiR/actions/workflows/pkgdown.yaml"],
+  "contIntegration": ["https://github.com/jmaspons/osmapiR/actions/workflows/R-CMD-check.yaml", "https://app.codecov.io/gh/jmaspons/osmapiR", "https://github.com/jmaspons/osmapiR/actions/workflows/pkgdown.yaml"],
   "developmentStatus": "https://www.repostatus.org/#active",
   "review": {
     "@type": "Review",

diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,14 @@
+## R CMD check results
+
+0 errors | 0 warnings | 0 note
+
+* This is a new release.
+
+urlchecker::url_check() errors and warnings for links that require authentication
+
+## Resubmission
+
+Addressed comments by Benjamin Altmann:
+
+* DESCRIPTION: package names, software names and API names in single quotes in title and description
+* Remove commented code lines in examples
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -325,10 +325,12 @@ Reinholdtsen
 relatedLink
 relationmember
 relationmembers
+releaseNotes
 rels
 repostatus
 reprex
 req
+Resubmission
 rlang
 rmarkdown
 Rmd
@@ -413,6 +415,7 @@ upd
 uri
 URI
 URL's
+urlchecker
 urlencoded
 UseMethod
 userName
@@ -423,6 +426,7 @@ uvAy
 vals
 vapply
 VAZUTwcmHJLwDEX
+Vectorization
 Vectorized
 vectorizing
 VignetteBuilder