Skip to contents

Resolve records from a layer by an identifier or name

Source: R/resolve.R
resolve.Rd

Attribute lookup (not a spatial operation): given one or more query values, return the matching record(s) from a layer. By default matches an id column exactly or a name column by substring; either can be overridden.

Usage

resolve(layer, query, by = c("ident", "name"), column = NULL, match = NULL)

Arguments

layer

An sf object or data.frame with attribute columns.

query

A character vector of one or more values to look up.

by

Character. "ident" (default) uses the layer's id column with exact matching; "name" uses the name column with substring matching. The columns are auto-detected. Ignored when column is supplied.

column

Character or NULL. Overrides the column to match against.

match

Character or NULL. "exact" or "substring". If NULL (default), derived from by (ident -> exact, name -> substring).

Value

A tibble::tibble() with a query column, the layer's non-geometry columns for matches, and source_url / retrieved_at provenance. A query with no match yields one row with NA data columns; a single combined warning lists all unmatched query values.

Examples

phu <- retrieve_phu_simple()
resolve(phu, "Toronto", by = "name")
#> # A tibble: 1 × 11
#>   query      OGF_ID PHU_ID PHU_NAME_ENG       PHU_NAME_FR GEOMETRY_UPDATE_DATE…¹
#>   <chr>       <int>  <int> <chr>              <chr>                        <dbl>
#> 1 Toronto 322020154   3895 Toronto Public He… Bureau de …          1785247330000
#> # ℹ abbreviated name: ¹​GEOMETRY_UPDATE_DATETIME
#> # ℹ 5 more variables: EFFECTIVE_DATETIME <dbl>, SYSTEM_DATETIME <dbl>,
#> #   OBJECTID <int>, source_url <chr>, retrieved_at <dttm>