create_areas: Create an Areas Object
In mrc-ide/naomi: Naomi Model for Subnational HIV Estimates

create_areas

R Documentation

Create an Areas Object

Description

Constructs and validates an areas object as an S3 class.

Usage

create_areas(
  levels = NULL,
  hierarchy = NULL,
  boundaries = NULL,
  area_merged = NULL
)

Arguments

`levels`	Data frame of area level metadata.
`hierarchy`	Data frame defining area hierarchy and area-level data.
`boundaries`	an `sf` object with boundary geometry for each area_id
`area_merged`	A merged version of `levels`, `hierarchy`, and `boundaries`.

Value

An object of class naomi_areas

Examples

data(demo_area_levels)
data(demo_area_hierarchy)
data(demo_area_boundaries)

areas <- create_areas(demo_area_levels, demo_area_hierarchy, demo_area_boundaries)
areas

mrc-ide/naomi documentation built on Jan. 6, 2025, 10:20 a.m.