calcular_indicador: Aggregate epidemiological indicators

In datasus: An Interface to Brazilian Public Health Data

Aggregate epidemiological indicators

Description

Aggregates numerator and denominator counts before calculating rates, proportions, ratios or case fatality. Rates use exact Poisson confidence intervals; proportions and case fatality use exact binomial intervals.

Usage

calcular_indicador(
  dados,
  numerador,
  denominador,
  grupo = NULL,
  tipo = c("taxa", "proporcao", "razao", "letalidade"),
  multiplicador = NULL,
  confianca = NULL,
  na_rm = FALSE,
  zero_denominador = c("na", "erro")
)

Arguments

dados	A non-empty data frame.
numerador	Name of the non-negative numerator column.
denominador	Name of the non-negative denominator column.
grupo	Optional character vector naming grouping columns.
tipo	Indicator type: '"taxa"', '"proporcao"', '"razao"' or '"letalidade"'.
multiplicador	Positive scale factor. When omitted, defaults to 100,000 for rates, 100 for proportions and case fatality, and 1 for ratios.
confianca	Optional confidence level. Exact intervals are available for rates, proportions and case fatality, but not for ratios.
na_rm	Whether rows with a missing numerator or denominator should be removed pairwise within each group. A group containing no complete row remains missing.
zero_denominador	How to handle zero denominators: '"na"' returns 'NA', while '"erro"' stops.

Value

A data frame containing the grouping columns, aggregated 'numerador', aggregated 'denominador', 'indicador', and optional confidence limits.

Examples

dados <- data.frame(
  ano = c(2024, 2024, 2025),
  casos = c(10, 20, 15),
  populacao = c(50000, 50000, 100000)
)
calcular_indicador(
  dados, "casos", "populacao", grupo = "ano", tipo = "taxa"
)

datasus documentation built on Oct. 7, 2026, 1:07 a.m.