ohsome_users_count {ohsome} | R Documentation |
Count OSM users
Description
Create an ohsome_query
object for OSM users count
Usage
ohsome_users_count(
boundary = NULL,
return_value = c("absolute", "density"),
grouping = NULL,
time = NULL,
...
)
Arguments
boundary |
Bounding geometries specified by WGS84 coordinates in the
order lon,lat . The geometries of sf are transformed to WGS84 if the CRS
of the object is known. The following classes are supported:
-
sf with (MULTI)POLYGON geometries
-
sfc with (MULTI)POLYGON geometries
-
sfg with (MULTI)POLYGON geometries and WGS 84 coordinates
-
bbox created with sf::st_bbox() or tmaptools::bb()
-
matrix created with sp::bbox() or osmdata::getbb()
-
character providing textual definitions of bounding polygons, boxes or
circles as allowed by the ohsome API (see
ohsome API - Boundaries
):
bboxes: WGS84 coordinates in the following format:
"id1:lon1,lat1,lon2,lat2|id2:lon1,lat1,lon2,lat2|..." OR
"lon1,lat1,lon2,lat2|lon1,lat1,lon2,lat2|..."
bcircles: WGS84 coordinates + radius in meter in the following
format: "id1:lon,lat,r|id2:lon,lat,r|..." OR
"lon,lat,r|lon,lat,r|..."
bpolys: WGS84 coordinates given as a list of coordinate pairs (as for
bboxes) or GeoJSON FeatureCollection. The first point has to be the same
as the last point and MultiPolygons are only supported in GeoJSON.
-
list of bbox , matrix or character . Bounding geometry types of all
list elements must be the same. Does not work with GeoJSON
FeatureCollections.
|
return_value |
character; the value to be returned by the ohsome API:
|
grouping |
character; group type(s) for grouped aggregations (only
available for queries to aggregation endpoints). The following group types
are available:
-
"boundary" groups the result by the given boundaries that are defined
through any of the boundary query parameters.
-
"key" groups the result by the given keys that are defined through the
groupByKeys query parameter.
-
"tag" groups the result by the given tags that are defined through the
groupByKey and groupByValues query parameters.
-
"type" groups the result by OSM element type.
-
c("boundary", "tag") groups the result by the given boundaries and
tags.
Not all of these group types are accepted by all of the aggregation
endpoints. Check
Grouping
for available group types.
|
time |
character; time parameter of the query (see
Supported time formats).
|
... |
Parameters of the request to the ohsome API endpoint.
|
Details
ohsome_users_count()
creates an ohsome_query
object for OSM users
aggregation. Boundary objects are passed via set_boundary()
into
ohsome_boundary()
.
Value
An ohsome_query
object. The object can be sent to the ohsome API
with ohsome_post()
. It consists of the following elements:
-
url
: The URL of the endpoint.
-
encode
: The way the information is encoded and then posted to the
ohsome API. Set as "form"
.
-
body
: The parameters of the query such as format
, filter
or
bpolys
.
See Also
ohsome API Endpoints – Users Aggregation
Examples
# Yearly count of users contributing to man-made objects around "Null Island"
ohsome_users_count("0,0,10", filter = "man_made=*", time = "2012/2022/P1Y")
[Package
ohsome version 0.2.2
Index]