Area query (data inside a polygon) — edr

Calls GET /collections/{collection_id}/area with a WKT POLYGON or MULTIPOLYGON in the coords parameter.

Usage

edr_area(
  client,
  collection_id,
  coords,
  datetime = NULL,
  parameter_name = NULL,
  z = NULL,
  crs = NULL,
  format = c("covjson", "json"),
  ...,
  instance_id = NULL,
  f = NULL
)

Arguments

client: An edr_client.
collection_id: Collection identifier.
coords: WKT POLYGON/MULTIPOLYGON string, or a matrix / data.frame of (lon, lat) rows that will be closed into a POLYGON. May also be an sf / sfc polygon if sf is installed.
datetime: ISO-8601 instant or interval, e.g. "2024-01-01/2024-12-31" or "2024-01-01/..".
parameter_name: Character vector of parameter names to filter on. Sent as a comma-separated parameter-name= query.
z: Vertical level filter.
crs: Optional CRS URI for the response.
format: "covjson" (default) or "json".
...: Additional query parameters passed through verbatim.
instance_id: Optional instance identifier. When supplied, the request is sent beneath /collections/{collection_id}/instances/{instance_id}. This keyword-only argument leaves existing positional calls unchanged.
f: Optional server-advertised output-format token sent as the EDR f query parameter. This is separate from format, which selects the client-side parser. For example, a strict coverage endpoint can use edr_position(..., format = "covjson", f = "CoverageJSON").

Value

An edr_response containing the server's CoverageJSON response. Convert it with covjson_to_tibble().