Check a geoscale against the model's declared regions

Warns when the two disagree. This is deliberately a warning, not an error: config@region remains authoritative, and a geoscale covering more ground than the model uses (a world map for a two-country model) is normal and useful.

Usage

check_geoscale_regions(geoscale, region, level = NULL)

Arguments

geoscale

A geoscales::GeoScale.

region

Character vector of declared model regions.

level

Level of the geoscale to match against. Defaults to the finest.

Value

Invisibly, the regions that are declared but absent from geoscale.

See also

Other geoscale: get_process_groups(), model_clusters(), plot_geoscale(), plot_map(), process_cluster_sweep(), setCalendar,config-method

Examples

# returns the declared regions the geoscale cannot place, and warns about them
gs <- topia$geoscales$squares
check_geoscale_regions(gs, c("W1", "W2", "C1"))        # all placed: character(0)
suppressWarnings(check_geoscale_regions(gs, c("W1", "NOWHERE")))