Navigate a region hierarchy — geoscale

geoscale_children() and geoscale_parents() step one geoframe; geoscale_descendants() and geoscale_ancestors() follow the transitive closure.

Usage

geoscale_children(x, geoframe, region, to = NULL)

geoscale_parents(x, geoframe, region, to = NULL)

geoscale_descendants(x, geoframe, region, to = NULL)

geoscale_ancestors(x, geoframe, region, to = NULL)

Arguments

x: A Geoscale.
geoframe: Geoframe that region belongs to.
region: Character vector of region codes at geoframe.
to: Target geoframe. For geoscale_children()/geoscale_parents() this defaults to the adjacent geoframe; for the transitive versions, NULL means all geoframes below/above.

Value

geoscale_children() and geoscale_parents() return a character vector of codes at a single geoframe. geoscale_descendants() and geoscale_ancestors() span several geoframes and so return a data.frame with columns geoframe and region — a bare character vector would be ambiguous, since the same code can occur at more than one geoframe.

Details

geoframe is required in every case — region codes are not unique across geoframes, so a bare code is ambiguous.

Examples

gs <- geoscale_example()
geoscale_children(gs, "country", "N")
#> [1] "N1" "N2"
geoscale_parents(gs, "state", "N1", to = "country")
#> [1] "N"
geoscale_descendants(gs, "country", "N")
#>   geoframe region
#> 1    state     N1
#> 2    state     N2
#> 3     zone     N1
#> 4     zone     ZB
#> 5     atom     A1
#> 6     atom     A2
#> 7     atom     A3
#> 8     atom     A4
geoscale_ancestors(gs, "atom", "A5")
#>   geoframe region
#> 1  country      S
#> 2    state     S1
#> 3     zone     ZB