proporcao: Calculate grouped proportions

View source: R/indicators.R

proporcaoR Documentation

Calculate grouped proportions

Description

Calculate grouped proportions

Usage

proporcao(
  dados,
  parte,
  total,
  grupo = NULL,
  multiplicador = 100,
  confianca = NULL,
  na_rm = FALSE,
  zero_denominador = c("na", "erro")
)

Arguments

dados

A non-empty data frame.

parte

Name of the subset count column.

total

Name of the total count column.

grupo

Optional character vector naming grouping columns.

multiplicador

Positive scale, default 100 for a percentage.

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 'proporcao'.

Examples

dados <- data.frame(ano = c(2024, 2024), vacinados = c(40, 45),
                    elegiveis = c(50, 50))
proporcao(dados, "vacinados", "elegiveis", grupo = "ano")

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