Add count parameter

rOpenSpain · Nov 28, 2023 · c2428c7 · c2428c7
1 parent fc2e1e0
commit c2428c7
Show file tree

Hide file tree

Showing 25 changed files with 81 additions and 47 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -9,3 +9,4 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+
diff --git a/.github/workflows/pkgdown-gh-pages-clean.yaml b/.github/workflows/pkgdown-gh-pages-clean.yaml
@@ -30,4 +30,5 @@ jobs:
         run: |
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, run_dont_run = TRUE)'
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, run_dont_run = TRUE)'
+
diff --git a/.github/workflows/roscron-check-standard.yaml b/.github/workflows/roscron-check-standard.yaml
@@ -51,3 +51,4 @@ jobs:
           needs: check
 
       - uses: r-lib/actions/check-r-package@v2
+
diff --git a/.github/workflows/rostemplate-gh-pages.yaml b/.github/workflows/rostemplate-gh-pages.yaml
@@ -34,3 +34,4 @@ jobs:
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, run_dont_run = TRUE)'
+
diff --git a/NEWS.md b/NEWS.md
@@ -1,10 +1,12 @@
 # CatastRoNav (development version)
 
 -   Improve condition handling.
+-   Add a `count` parameter that allows to set the maximum number of features to
+    be returned.
 
 # CatastRoNav 0.0.2
 
--   Make `sf` objects valid with `sf::st_make_valid()`.
+-   Make \CRANpkg{sf} objects valid with `sf::st_make_valid()`.
 
 # CatastRoNav 0.0.1
 

diff --git a/R/wfs_ad.R b/R/wfs_ad.R
@@ -7,7 +7,7 @@
 #'
 #' @seealso [sf::st_bbox()]
 #'
-#' @return A `sf` object.
+#' @return A \CRANpkg{sf} object.
 #' @source [SITNA – Catastro de Navarra](https://sitna.navarra.es/geoportal/)
 #'
 #' @details
@@ -18,7 +18,7 @@
 #' [EPSG:25830](https://epsg.io/25830) - ETRS89 / UTM zone 30N. The result is
 #' provided always in the SRS provided in `srs`.
 #'
-#' When `x` is a `sf` object, the value `srs` is ignored. The query is
+#' When `x` is a \CRANpkg{sf} object, the value `srs` is ignored. The query is
 #' performed using [EPSG:25830](https://epsg.io/25830) (ETRS89 / UTM zone 30N)
 #' and the spatial object is projected back to the SRS of the initial object.
 #'
@@ -37,7 +37,8 @@
 #' }
 #'
 #' @seealso [CatastRo::catr_wfs_get_address_bbox()]
-catrnav_wfs_get_address_bbox <- function(x, srs, verbose = FALSE) {
+catrnav_wfs_get_address_bbox <- function(x, srs, verbose = FALSE,
+                                         count = NULL) {
   # Switch to stored queries
   stored_query <- "AD:Address"
 
@@ -51,6 +52,7 @@ catrnav_wfs_get_address_bbox <- function(x, srs, verbose = FALSE) {
     service = "WFS",
     request = "getfeature",
     typenames = stored_query,
+    count = count,
     # Stored query
     bbox = bbox_res$bbox,
     SRSNAME = bbox_res$incrs

diff --git a/R/wfs_bu.R b/R/wfs_bu.R
@@ -8,13 +8,16 @@
 #'     the bounding box: `c(xmin, ymin, xmax, ymax)`
 #'   - A `sf/sfc` object, as provided by the **sf** package.
 #' @param srs SRS/CRS to use on the query. See **Details**.
-#'
 #' @param verbose Logical, displays information. Useful for debugging, default
 #'   is `FALSE`.
+#' @param count integer, indicating the maximum number of features to return.
+#'   The default value `NULL` does not pass this parameter to the query,
+#'   and the maximum number of features would be determined by the default value
+#'   of the API service (5,000 in this case).
 #'
 #' @seealso [sf::st_bbox()]
 #'
-#' @return A `sf` object.
+#' @return A \CRANpkg{sf} object.
 #' @source [SITNA – Catastro de Navarra](https://sitna.navarra.es/geoportal/)
 #'
 #' @details
@@ -25,7 +28,7 @@
 #' [EPSG:25830](https://epsg.io/25830) - ETRS89 / UTM zone 30N. The result is
 #' provided always in the SRS provided in `srs`.
 #'
-#' When `x` is a `sf` object, the value `srs` is ignored. The query is
+#' When `x` is a \CRANpkg{sf} object, the value `srs` is ignored. The query is
 #' performed using [EPSG:25830](https://epsg.io/25830) (ETRS89 / UTM zone 30N)
 #' and the spatial object is projected back to the SRS of the initial object.
 #'
@@ -44,7 +47,8 @@
 #' }
 #'
 #' @seealso [CatastRo::catr_wfs_get_buildings_bbox()]
-catrnav_wfs_get_buildings_bbox <- function(x, srs, verbose = FALSE) {
+catrnav_wfs_get_buildings_bbox <- function(x, srs, verbose = FALSE,
+                                           count = NULL) {
   # Switch to stored queries
   stored_query <- "BU:Building"
 
@@ -58,6 +62,7 @@ catrnav_wfs_get_buildings_bbox <- function(x, srs, verbose = FALSE) {
     service = "WFS",
     request = "getfeature",
     typenames = stored_query,
+    count = count,
     # Stored query
     bbox = bbox_res$bbox,
     SRSNAME = bbox_res$incrs

diff --git a/R/wfs_cp.R b/R/wfs_cp.R
@@ -7,7 +7,7 @@
 #'
 #' @seealso [sf::st_bbox()]
 #'
-#' @return A `sf` object.
+#' @return A \CRANpkg{sf} object.
 #' @source [SITNA – Catastro de Navarra](https://sitna.navarra.es/geoportal/)
 #'
 #' @details
@@ -18,7 +18,7 @@
 #' [EPSG:25830](https://epsg.io/25830) - ETRS89 / UTM zone 30N. The result is
 #' provided always in the SRS provided in `srs`.
 #'
-#' When `x` is a `sf` object, the value `srs` is ignored. The query is
+#' When `x` is a \CRANpkg{sf} object, the value `srs` is ignored. The query is
 #' performed using [EPSG:25830](https://epsg.io/25830) (ETRS89 / UTM zone 30N)
 #' and the spatial object is projected back to the SRS of the initial object.
 #'
@@ -37,7 +37,8 @@
 #' }
 #'
 #' @seealso [CatastRo::catr_wfs_get_parcels_bbox()]
-catrnav_wfs_get_parcels_bbox <- function(x, srs, verbose = FALSE) {
+catrnav_wfs_get_parcels_bbox <- function(x, srs, verbose = FALSE,
+                                         count = NULL) {
   # Switch to stored queries
   stored_query <- "CP:CadastralParcel"
 
@@ -51,6 +52,7 @@ catrnav_wfs_get_parcels_bbox <- function(x, srs, verbose = FALSE) {
     service = "WFS",
     request = "getfeature",
     typenames = stored_query,
+    count = count,
     # Stored query
     bbox = bbox_res$bbox,
     SRSNAME = bbox_res$incrs

diff --git a/README.Rmd b/README.Rmd
@@ -25,7 +25,7 @@ library(CatastRoNav)
 [![rOS-badge](https://ropenspain.github.io/rostemplate/reference/figures/ropenspain-badge.svg)](https://ropenspain.es/)
 [![CatastRoNav status
 badge](https://ropenspain.r-universe.dev/badges/CatastRoNav)](https://ropenspain.r-universe.dev/CatastRoNav)
-[![R-CMD-check](https://github.com/rOpenSpain/CatastRoNav/workflows/R-CMD-check/badge.svg)](https://github.com/rOpenSpain/CatastRoNav/actions?query=workflow%3AR-CMD-check)
+[![R-CMD-check](https://github.com/rOpenSpain/CatastRoNav/actions/workflows/roscron-check-standard.yaml/badge.svg)](https://github.com/rOpenSpain/CatastRoNav/actions/workflows/roscron-check-standard.yaml)
 [![codecov](https://codecov.io/gh/rOpenSpain/CatastroNav/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rOpenSpain/CatastroNav)
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.6366407-blue)](https://doi.org/10.5281/zenodo.6366407)
 [![Project-Status:Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
@@ -62,7 +62,7 @@ install_github("rOpenSpain/CatastRoNav", dependencies = TRUE)
 ## Usage
 
 The WFS service allows to download vector objects of specific cadastral
-elements. The result is provided as `sf` objects (See **sf** package).
+elements. The result is provided as \CRANpkg{sf} objects (See **sf** package).
 
 ```{r wfs}
 library(CatastRoNav)
@@ -98,7 +98,7 @@ similar functionalities for Spain excluding the Basque Country and Navarre.
 ## Terms and conditions of use
 
 Data provided by the Government of Navarre under [Creative Commons Attribution
-(CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/deed.en_EN). The
+(CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/deed.en_en). The
 service is provided "as is", and without guarantee of any kind, implicit or
 explicit.
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 [![rOS-badge](https://ropenspain.github.io/rostemplate/reference/figures/ropenspain-badge.svg)](https://ropenspain.es/)
 [![CatastRoNav status
 badge](https://ropenspain.r-universe.dev/badges/CatastRoNav)](https://ropenspain.r-universe.dev/CatastRoNav)
-[![R-CMD-check](https://github.com/rOpenSpain/CatastRoNav/workflows/R-CMD-check/badge.svg)](https://github.com/rOpenSpain/CatastRoNav/actions?query=workflow%3AR-CMD-check)
+[![R-CMD-check](https://github.com/rOpenSpain/CatastRoNav/actions/workflows/roscron-check-standard.yaml/badge.svg)](https://github.com/rOpenSpain/CatastRoNav/actions/workflows/roscron-check-standard.yaml)
 [![codecov](https://codecov.io/gh/rOpenSpain/CatastroNav/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rOpenSpain/CatastroNav)
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.6366407-blue)](https://doi.org/10.5281/zenodo.6366407)
 [![Project-Status:Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
@@ -47,7 +47,7 @@ install_github("rOpenSpain/CatastRoNav", dependencies = TRUE)
 ## Usage
 
 The WFS service allows to download vector objects of specific cadastral
-elements. The result is provided as `sf` objects (See **sf** package).
+elements. The result is provided as objects (See **sf** package).
 
 ``` r
 library(CatastRoNav)
@@ -96,7 +96,7 @@ and Navarre.
 
 Data provided by the Government of Navarre under [Creative Commons
 Attribution (CC BY
-4.0)](https://creativecommons.org/licenses/by/4.0/deed.en_EN). The
+4.0)](https://creativecommons.org/licenses/by/4.0/deed.en_en). The
 service is provided “as is”, and without guarantee of any kind, implicit
 or explicit.
 

diff --git a/codemeta.json b/codemeta.json
@@ -14,7 +14,7 @@
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.3.1 (2023-06-16 ucrt)",
+  "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
   "author": [
     {
       "@type": "Person",
@@ -178,7 +178,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "854.073KB",
+  "fileSize": "890.901KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",
@@ -199,7 +199,7 @@
   ],
   "releaseNotes": "https://github.com/rOpenSpain/CatastRoNav/blob/master/NEWS.md",
   "readme": "https://github.com/rOpenSpain/CatastRoNav/blob/main/README.md",
-  "contIntegration": ["https://github.com/rOpenSpain/CatastRoNav/actions?query=workflow%3AR-CMD-check", "https://app.codecov.io/gh/rOpenSpain/CatastroNav"],
+  "contIntegration": ["https://github.com/rOpenSpain/CatastRoNav/actions/workflows/roscron-check-standard.yaml", "https://app.codecov.io/gh/rOpenSpain/CatastroNav"],
   "developmentStatus": "https://www.repostatus.org/#active",
   "keywords": ["r", "maps", "spain", "navarra", "catastro", "r-package", "r-stats", "ropenspain"]
 }
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -1,14 +1,10 @@
-CMD
 CRS
 Cadastral
 Cadastre
-CatastRo
-CatastRoNav’
 Catastro
 DOI
 EPSG
 ETRS
-Hernangomez
 Navarra
 ORCID
 Olite
@@ -19,9 +15,7 @@ SRS
 WFS
 cadastral
 cadastre
-codecov
 de
 mapSpain
 organisations
 pre
-rOS
diff --git a/inst/schemaorg.json b/inst/schemaorg.json
@@ -19,7 +19,7 @@
         "name": "R",
         "url": "https://r-project.org"
       },
-      "runtimePlatform": "R version 4.3.1 (2023-06-16 ucrt)",
+      "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
       "version": "0.0.2.9000"
     },
     {

diff --git a/man/catrnav_wfs_get_address_bbox.Rd b/man/catrnav_wfs_get_address_bbox.Rd
diff --git a/man/catrnav_wfs_get_buildings_bbox.Rd b/man/catrnav_wfs_get_buildings_bbox.Rd
diff --git a/man/catrnav_wfs_get_parcels_bbox.Rd b/man/catrnav_wfs_get_parcels_bbox.Rd
diff --git a/man/figures/README-wfs-1.png b/man/figures/README-wfs-1.png
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -6,3 +6,4 @@ template:
 authors:
   Diego Hernangómez:
     href: 'https://dieghernan.github.io/'
+
diff --git a/tests/testthat/test-catrnav_wfs_ad.R b/tests/testthat/test-catrnav_wfs_ad.R
@@ -19,14 +19,17 @@ test_that("BBOX Check projections", {
       1071171, 4748024
     ),
     srs = 25829,
-    verbose = TRUE
+    verbose = TRUE,
+    count = 5
   ))
 
   obj <- catrnav_wfs_get_address_bbox(c(1071071, 4747924, 1071171, 4748024),
-    srs = 25829
+    srs = 25829,
+    count = 10
   )
 
   expect_true(sf::st_crs(obj) == sf::st_crs(25829))
+  expect_true(nrow(obj) == 10)
 
 
   # test conversion