Estimate IPM KPIs from row-level IPM flags

Estimates Ecuador IPM analytical outputs from already-built row-level variables. The function consumes ipm_score, tpm, and tpem, or builds them from the 12 registered component columns with enemdu_build_ipm_flags(). If requested, it can first call enemdu_build_ipm_components(), respecting that builder's pending-component behavior.

Usage

enemdu_kpi_ipm(
  data,
  survey_type = c("anual", "trimestral", "mensual"),
  by = NULL,
  ids = "upm",
  strata = "estrato",
  weight = "fexp",
  score_var = "ipm_score",
  tpm_var = "tpm",
  tpem_var = "tpem",
  build_components = FALSE,
  build_flags = TRUE,
  component_cols = NULL,
  strict = TRUE,
  ...
)

Arguments

data

A data frame.

survey_type

One of "anual", "trimestral", or "mensual".

by

Optional grouping variable or variables.

ids

Primary sampling unit variable.

strata

Survey strata variable.

weight

Survey expansion factor variable.

score_var

Row-level IPM score variable.

tpm_var

Row-level multidimensional poverty flag variable.

tpem_var

Row-level extreme multidimensional poverty flag variable.

build_components

Logical. If TRUE, call enemdu_build_ipm_components() before flags are checked.

build_flags

Logical. If TRUE, build row-level flags from registered component columns when those components are available.

component_cols

Optional registered IPM component columns passed to enemdu_build_ipm_flags().

strict

Logical. If TRUE, abort on missing or invalid score or flag variables.

...

Additional named arguments. Arguments matching enemdu_build_ipm_components() are used only when build_components = TRUE; the remaining arguments are passed to survey estimators.

Value

A tibble with survey KPI estimates for tpm, tpem, A, and ipm, plus non-official validation metadata.

Details

The aggregate outputs are tpm, tpem, A, and ipm. Here A is the average deprivation intensity among multidimensionally poor persons, and aggregate ipm is calculated as tpm * A. These are aggregate KPI outputs, not row-level variables.

This function does not derive new raw IPM component rules and does not claim official institutional validation.