taxa_mortalidade: Calculate grouped mortality rates

View source: R/indicators.R

taxa_mortalidadeR Documentation

Calculate grouped mortality rates

Description

Calculate grouped mortality rates

Usage

taxa_mortalidade(
  dados,
  obitos,
  populacao,
  grupo = NULL,
  multiplicador = 1e+05,
  confianca = NULL,
  na_rm = FALSE,
  zero_denominador = c("na", "erro")
)

Arguments

dados

A non-empty data frame.

obitos

Name of the deaths column.

populacao

Name of the population denominator column.

grupo

Optional character vector naming grouping columns.

multiplicador

Positive rate scale, default 100,000.

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 with aggregated counts and 'taxa_mortalidade'.

Examples

dados <- data.frame(ano = c(2024, 2024), obitos = c(3, 7),
                    populacao = c(5000, 5000))
taxa_mortalidade(dados, "obitos", "populacao", grupo = "ano")

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