Rename query builders

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: osmdata
 Title: Import 'OpenStreetMap' Data as Simple Features or Spatial Objects
-Version: 0.3.0.9026
+Version: 0.3.0.9027
 Authors@R: c(
     person("Joan", "Maspons", , "joanmaspons@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2286-8727")),

NAMESPACE

@@ -15,9 +15,11 @@ S3method(trim_osmdata,osmdata_sf)
 S3method(trim_osmdata,osmdata_sp)
 export(add_osm_feature)
 export(add_osm_features)
+export(add_osm_tags)
 export(available_features)
 export(available_tags)
 export(bbox_to_string)
+export(filter_osm_tags)
 export(filter_osm_user)
 export(get_overpass_url)
 export(getbb)

NEWS.md

@@ -10,6 +10,7 @@
 
 - `getbb()` can query wikidata ids for OSM relations properties (P402) (idea from @mhpob in #401, implemented in #403).
 - Add `filter_osm_user()` to add user filter to `overpass_queries` objects (#414).
+- Rename `add_osm_feature()` -> `filter_osm_tags()` and `add_osm_features()` -> `add_osm_tags()`. Keep the alias silent for now, the old names will be DEPRECATED in a future version (#417).
 
 ## Minor changes
 

R/deprecated.R

@@ -18,6 +18,20 @@
 #'   }
 #' }
 #'
+#' \describe{
+#'   \item{`add_osm_feature()`}{
+#'     Please use [`filter_osm_tags()`] instead.
+#'     In future versions, using [`add_osm_feature()`] will produce a deprecation warning.
+#'   }
+#' }
+#'
+#' \describe{
+#'   \item{`add_osm_features()`}{
+#'     Please use [`add_osm_tags()`] instead.
+#'     In future versions, using [`add_osm_features()`] will produce a deprecation warning.
+#'   }
+#' }
+#'
 #' @name osmdata-deprecated
 #' @keywords internal
 NULL

R/elevation.R

@@ -17,7 +17,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("omaha nebraska") |>
-#'     add_osm_feature (key = "highway")
+#'     filter_osm_tags (key = "highway")
 #' # Elevation can only be applied to \pkg{silicate} 'SC'-class data:
 #' dat <- osmdata_sc (query)
 #' dat$vertex

R/get-osmdata-df.R

@@ -3,7 +3,7 @@
 #'
 #' @inheritParams osmdata_sf
 #' @param q An object of class `overpass_query` constructed with
-#'      [opq()] and [add_osm_feature()] or a string with a valid query, such
+#'      [opq()] and [filter_osm_tags()] or a string with a valid query, such
 #'      as `"(node(39.4712701,-0.3841326,39.4713799,-0.3839475);); out;"`.
 #'      May be be omitted, in which case the attributes of the [data.frame]
 #'      will not include the query. See examples below.
@@ -13,7 +13,7 @@
 #'      and tags of the the objects from the query.
 #'
 #' @details If you are not interested in the geometries of the results, it's a
-#'      good option to query for objects that match the features only and forget
+#'      good option to query for objects that match the statements only and forget
 #'      about members of the ways and relations. You can achieve this by passing
 #'      the parameter `body = "tags"` to [opq()].
 #'
@@ -23,7 +23,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("hampi india") |>
-#'     add_osm_feature (key = "historic", value = "ruins")
+#'     filter_osm_tags (key = "historic", value = "ruins")
 #' # Then extract data from 'Overpass' API
 #' hampi_df <- osmdata_data_frame (query)
 #' attr (hampi_df, "bbox")

R/get-osmdata-sc.R

@@ -14,7 +14,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("hampi india") |>
-#'     add_osm_feature (key = "historic", value = "ruins")
+#'     filter_osm_tags (key = "historic", value = "ruins")
 #' # Then extract data from 'Overpass' API
 #' hampi_sc <- osmdata_sc (query)
 #' }

R/get-osmdata-sf.R

@@ -5,7 +5,7 @@
 #' the \pkg{sf} package into the current workspace with 'library(sf)'.
 #'
 #' @param q An object of class `overpass_query` constructed with
-#'      [opq()] and [add_osm_feature()] or a string with a valid query, such
+#'      [opq()] and [filter_osm_tags()] or a string with a valid query, such
 #'      as `"(node(39.4712701,-0.3841326,39.4713799,-0.3839475);); out;"`.
 #'      May be be omitted, in which case the [osmdata] object will not
 #'      include the query. See examples below.
@@ -24,7 +24,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("hampi india") |>
-#'     add_osm_feature (key = "historic", value = "ruins")
+#'     filter_osm_tags (key = "historic", value = "ruins")
 #' # Then extract data from 'Overpass' API
 #' hampi_sf <- osmdata_sf (query)
 #' }

R/get-osmdata-sp.R

@@ -12,7 +12,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("hampi india") |>
-#'     add_osm_feature (key = "historic", value = "ruins")
+#'     filter_osm_tags (key = "historic", value = "ruins")
 #' # Then extract data from 'Overpass' API
 #' hampi_sp <- osmdata_sp (query)
 #' }

R/get-osmdata-xml.R

@@ -3,7 +3,7 @@
 #' or a raw vector.
 #'
 #' @param q An object of class `overpass_query` constructed with
-#'     [opq()] and [add_osm_feature()] or a string with a valid query, such as
+#'     [opq()] and [filter_osm_tags()] or a string with a valid query, such as
 #'     `"(node(39.4712701,-0.3841326,39.4713799,-0.3839475);); out;"`. See
 #'     examples below.
 #' @param filename If given, OSM data are saved to the named file
@@ -23,7 +23,7 @@
 #' @examples
 #' \dontrun{
 #' query <- opq ("hampi india") |>
-#'     add_osm_feature (key = "historic", value = "ruins")
+#'     filter_osm_tags (key = "historic", value = "ruins")
 #' # Then extract data from 'Overpass' API and save to local file:
 #' osmdata_xml (query, filename = "hampi.osm")
 #' }