% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/steps_registry.R
\name{steps_table_registry}
\alias{steps_table_registry}
\title{WHO STEPS Data Book Table Registry}
\usage{
steps_table_registry()
}
\value{
A list of table specification lists.
}
\description{
Defines all standard tables from the WHO STEPS Epi Info report template.
Each entry specifies the table metadata; generic compute and formatting
functions use this registry to produce the full data book automatically.
}
\section{Table types}{

\describe{
\item{proportion}{Single binary indicator: \% (95\% CI) by age × sex.
Most common type. Example: "Current smokers among all respondents."}
\item{mean}{Continuous variable: mean (95\% CI) by age × sex.
Example: "Mean BMI (kg/m²)."}
\item{category}{Multi-level factor: \% per level (95\% CI) by age × sex.
Example: "BMI classifications (Underweight / Normal / Overweight / Obese)."}
\item{cascade}{Diagnosis → treatment → control chain: multiple proportions
with nested denominators. Example: "Raised BP diagnosis, treatment and control."}
\item{combined}{Summary of combined risk factors: 0, 1-2, 3-5 risk factors.}
}
}

\section{Registry fields}{

\describe{
\item{id}{Unique short identifier (e.g., "T_smoking_current").}
\item{section}{Data book section (e.g., "Tobacco Use", "Blood Pressure").}
\item{step}{STEPS step number (1, 2, or 3).}
\item{title}{Table title as shown in the data book.}
\item{description}{One-line description from the WHO template.}
\item{type}{One of: "proportion", "mean", "category", "cascade", "combined".}
\item{variable}{Column name(s) in the cleaned data frame to analyse.
For proportion: single logical variable.
For mean: single numeric variable.
For category: single factor variable.
For cascade: named list of logical variables.}
\item{denominator}{NULL (= all respondents) or column name for subsetting
(e.g., "current_alcohol" to restrict to drinkers).}
\item{levels}{For category type: named character vector of level labels.}
\item{epi_info}{Epi Info program name(s) for reference.}
\item{unit}{Display unit (e.g., "\%", "mmHg", "cm", "kg/m²", "mmol/L").}
\item{questions}{STEPS instrument question codes used.}
\item{sex_panels}{Logical. TRUE = 3 panels (Men/Women/Both);
FALSE = 2 panels (Men/Women only, e.g., height/weight means).
Default TRUE.}
}
}

