Package 'datasus'

Description

'datasus' provides a stable interface to aggregated TABNET queries, OpenDataSUS resources, record-level DATASUS files, territorial references and epidemiological analysis helpers. Discovery functions can be used before any download, and local catalogs and transformations remain usable without network access.

Main workflow

Start with [datasus_catalogo()] for supported TABNET datasets, [opendatasus_catalogo()] for contemporary portal datasets, or [microdados_catalogo()] for raw DBC/DBF file families. Plan requests with [datasus_opcoes()], [opendatasus_recursos()], [opendatasus_arquivos()] or [microdados_arquivos()] before querying or downloading data.

Use [opendatasus_baixar()] and [microdados_baixar()] when another engine will read the files, or [opendatasus_ler()] and [microdados_ler()] for in-memory workflows. System-specific functions such as [sim()], [sinasc()], [sih_producao()] and [cnes()] provide concise entry points for common data products.

Reproducibility and validation

Downloaded objects carry source, consultation time, local path and checksum metadata retrievable with [datasus_proveniencia()]. Use [datasus_dicionario()] and [datasus_validar_esquema()] to inspect curated fields and detect missing or type-incompatible analysis fields. Cache paths use [tools::R_user_dir()] by default and can be changed with option 'datasus.cache_dir'.

Compatibility

Historical 'sim_*()' and 'sinasc_nv_*()' functions remain available for existing scripts. Their public signatures are preserved; new workflows should prefer [sim()] and [sinasc()]. Network integrations are tested only by explicit or scheduled smoke tests, while regular package tests use local fixtures and mocks.

Author(s)

Maintainer: Renato Prado Siqueira [email protected]

Authors:

• Renato Prado Siqueira [email protected]

See Also

Useful links:

• https://github.com/rpradosiqueira/datasus

• Report bugs at https://github.com/rpradosiqueira/datasus/issues

Description

Validates a territorial code column and appends the corresponding current IBGE names and hierarchy. Six-digit DATASUS municipality codes are converted to seven-digit IBGE codes. The function does not redistribute historical observations across boundary changes.

Usage

adicionar_territorio(
  dados,
  codigo,
  nivel = c("municipio", "uf", "regiao"),
  desconhecido = c("erro", "na"),
  sobrescrever = FALSE
)

Arguments

Value

'dados' with territorial columns appended.

Examples

dados <- data.frame(codmun = c("500270", "500370"), casos = c(10, 5))
adicionar_territorio(dados, "codmun")

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

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"
)

Description

Calculates 'eventos / populacao * multiplicador' with explicit validation of counts and denominators. Missing values propagate to the result.

Usage

calcular_taxa(
  eventos,
  populacao,
  multiplicador = 1e+05,
  zero_denominador = c("na", "erro")
)

Arguments

Value

A numeric vector with the calculated rates.

Examples

calcular_taxa(c(10, 25), c(10000, 20000))
calcular_taxa(25, 20000, multiplicador = 1000)

Description

Generate a Brazilian epidemiological calendar

Usage

calendario_epidemiologico(ano)

Arguments

Value

A data frame with the 52 or 53 epidemiological weeks in the year.

Examples

calendario_epidemiologico(2026)

Description

Supports establishments, physical resources, human resources and health teams. Use 'datasus_catalogo("cnes")' to list the available datasets.

Usage

cnes(
  conjunto = "estabelecimentos",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
cnes(uf = "MS")
cnes(
  conjunto = "leitos_internacao",
  uf = "MS",
  periodo = "last"
)
})
options(old_options)

Description

Adds absent territory-period rows while protecting existing observations. By default the territorial universe is the set observed in 'dados'. Supply 'uf' to complete all current territories in one or more states, or 'territorios' for an explicit universe. If 'periodos' is omitted, the distinct periods observed in the data are used.

Usage

completar_territorios(
  dados,
  codigo,
  periodo = NULL,
  grupo = NULL,
  nivel = c("municipio", "uf", "regiao"),
  territorios = NULL,
  uf = NULL,
  periodos = NULL,
  preencher = list(),
  adicionar = TRUE
)

Arguments

Value

A data frame ordered by groups, territory and period.

Examples

dados <- data.frame(
  codmun = c("500270", "500270", "500370"),
  ano = c(2023, 2025, 2023),
  casos = c(10, 12, 5)
)
completar_territorios(
  dados, "codmun", "ano",
  periodos = 2023:2025,
  preencher = list(casos = 0)
)

Description

Returns the local catalog used by the health-services query functions. This function does not access the network.

Usage

datasus_catalogo(sistema = NULL)

Arguments

Value

A data frame with the system, dataset name, category, description and geographic form scope.

Examples

datasus_catalogo()
datasus_catalogo("cnes")

Description

Returns the fields currently standardized by [datasus_padronizar()]. Contemporary schemas cover the variables documented in the official ESAVI, e-SUS Notifica, PNI and hospital-occupancy dictionaries. Fields added by a source after the packaged dictionary was released remain untouched and can be detected with [datasus_validar_esquema()].

Usage

datasus_dicionario(sistema, tipo = NULL)

Arguments

Value

A data frame with original field, standardized field, description, target class and date format.

Examples

datasus_dicionario("sim")
datasus_dicionario("sih", "RD")

Description

Reads the current TABNET form and returns its row, column, measure, period and filter choices. Filter names in the returned 'filtros' list are the names accepted by the query functions.

Usage

datasus_opcoes(sistema, conjunto = NULL, uf = NULL, abrangencia = NULL)

Arguments

Value

An object of class 'datasus_opcoes'. Its components are data frames named 'linha', 'coluna', 'conteudo' and 'periodo', plus a named list 'filtros'.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
op <- datasus_opcoes("sih", uf = "MS")
op$conteudo
op$filtros$carater_atendimento
})
options(old_options)

Description

Renames curated fields and converts documented dates, identifiers, numeric measures and logical indicators. Unrecognized columns and coded category values are preserved exactly as published.

Usage

datasus_padronizar(dados, sistema, tipo = NULL)

Arguments

Value

The input data frame with curated fields renamed and typed. Provenance is preserved and the applied dictionary is attached as attribute '"datasus_dicionario"'.

Examples

example <- data.frame(
  MUNIC_RES = "120040",
  DT_INTER = "20240110",
  DIAG_PRINC = "J18"
)
datasus_padronizar(example, "sih")

Description

Retrieve DATASUS provenance metadata

Usage

datasus_proveniencia(x)

Arguments

Value

A named list, or 'NULL' when no provenance metadata is attached.

Description

Returns the package's offline territorial reference. The municipality table is generated from the official IBGE Localities API and contains current municipality, state, macroregion, immediate/intermediate region and legacy micro/mesoregion codes and names.

Usage

datasus_territorios(nivel = c("municipio", "uf", "regiao"), uf = NULL)

Arguments

Value

A data frame. Source and extraction metadata are available through [datasus_proveniencia()].

Examples

datasus_territorios("regiao")
datasus_territorios("uf")
head(datasus_territorios("municipio", uf = "MS"))

Description

Compares the columns of a raw or standardized data frame with fields in [datasus_dicionario()]. This detects missing fields and incompatible target classes without treating newly introduced source columns as errors.

Usage

datasus_validar_esquema(
  dados,
  sistema,
  tipo = NULL,
  campos = NULL,
  estrito = FALSE
)

Arguments

Value

A data frame with source and standardized field names, presence, observed column and class, expected class and status. Attribute '"campos_extras"' lists columns outside the curated dictionary.

Examples

dados <- data.frame(
  dt_vacina = "2025-01-10",
  co_municipio_paciente = "5002704"
)
datasus_validar_esquema(dados, "pni_doses")

Description

Downloads anonymous individual records from the e-SUS Notifica ESAVI module. The source contains notifications since January 2021 and is continuously updated. An event following immunization does not by itself establish a causal association with a vaccine.

Usage

esavi(
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  colunas = NULL,
  normalizar = FALSE,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource with provenance metadata.

References

OpenDataSUS. ESAVI - Dados sobre Eventos Supostamente Atribuíveis a Vacinação. https://dadosabertos.saude.gov.br/dataset/esavi

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
eventos <- esavi(n_max = 1000)
datasus_proveniencia(eventos)
})
options(old_options)

Description

Downloads anonymous mild and moderate influenza-like illness notifications published by annual dataset and state. These records are distinct from hospitalized severe acute respiratory syndrome records returned by [sivep_gripe()].

Usage

esus_sindrome_gripal(
  uf,
  ano = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  colunas = NULL,
  normalizar = FALSE,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource with provenance metadata.

References

OpenDataSUS. Notificações de Síndrome Gripal. https://dadosabertos.saude.gov.br/dataset?query=sindrome+gripal

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
casos <- esus_sindrome_gripal(uf = "MS", ano = 2024, n_max = 1000)
})
options(old_options)

Description

Extracts the first territorial code embedded in labels such as '"500270 Campo Grande"' and then validates and converts it with [normalizar_codigo_ibge()].

Usage

extrair_codigo_ibge(
  x,
  nivel = c("municipio", "uf", "regiao"),
  formato = NULL,
  desconhecido = c("erro", "na", "manter")
)

Arguments

Value

A normalized character vector.

Examples

extrair_codigo_ibge(c("500270 Campo Grande", "500370 Dourados"))

Description

Provides the three financial tables linked by the DATASUS TABNET catalog: federal resources, approved production values by provider, and payment authorization guides. Availability periods vary and may be historical.

Usage

financiamento_sus(
  conjunto = "recursos_federais",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
financiamento_sus(uf = "MS")
financiamento_sus(conjunto = "producao_prestador", uf = "MS")
})
options(old_options)

Description

Uses chi-squared quantiles for exact Poisson count limits and divides them by the supplied denominator. Event counts must be whole numbers.

Usage

intervalo_taxa(
  eventos,
  populacao,
  multiplicador = 1e+05,
  confianca = 0.95,
  zero_denominador = c("na", "erro")
)

Arguments

Value

A data frame with event counts, denominators, rates and lower and upper confidence limits.

Examples

intervalo_taxa(c(0, 10), c(10000, 10000))

Description

Performs a many-to-one join from observations to a population table, preserving observation order and rejecting ambiguous denominator keys. This is designed to connect outputs from [populacao_residente()] to event tables before calculating population-based indicators.

Usage

juntar_populacao(
  dados,
  populacao,
  por,
  coluna_populacao = "populacao",
  nome = "populacao",
  ausente = c("erro", "na"),
  sobrescrever = FALSE
)

Arguments

Value

'dados' with one validated population denominator column appended.

Examples

eventos <- data.frame(codigo = c("A", "B"), ano = 2024, casos = c(2, 4))
denominadores <- data.frame(
  municipio = c("A", "B"), ano = 2024, habitantes = c(1000, 2000)
)
juntar_populacao(
  eventos, denominadores,
  por = c(codigo = "municipio", ano = "ano"),
  coluna_populacao = "habitantes"
)

Description

Calculate grouped case fatality

Usage

letalidade(
  dados,
  obitos,
  casos,
  grupo = NULL,
  multiplicador = 100,
  confianca = NULL,
  na_rm = FALSE,
  zero_denominador = c("na", "erro")
)

Arguments

Value

A data frame with aggregated counts and 'letalidade'.

Examples

dados <- data.frame(doenca = c("A", "A"), obitos = c(1, 2),
                    casos = c(20, 30))
letalidade(dados, "obitos", "casos", grupo = "doenca")

Description

Calculate moving averages

Usage

media_movel(
  x,
  janela = 7L,
  alinhamento = c("direita", "centro", "esquerda"),
  parcial = FALSE,
  na_rm = FALSE
)

Arguments

Value

A numeric vector of the same length as 'x'.

Examples

media_movel(1:7, janela = 3)
media_movel(c(1, NA, 3, 4), janela = 2, na_rm = TRUE)

Description

Builds the official DATASUS transfer paths and optionally checks whether each file currently exists. SIM and SINASC files are annual; SIH files are monthly.

Usage

microdados_arquivos(
  sistema,
  tipo = NULL,
  ano,
  mes = NULL,
  uf = NULL,
  preliminares = TRUE,
  verificar = TRUE,
  timeout = 120
)

Arguments

Value

A data frame containing official file names, URLs and existence checks. Provenance records the selection and consultation time.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
microdados_arquivos("sim", ano = 2023, uf = "RR")
microdados_arquivos("sih", ano = 2024, mes = 1, uf = "AC")
})
options(old_options)

Description

Discovers and downloads one or more official DBC files. Downloads use a dedicated cache below option 'datasus.cache_dir'; 'atualizar = TRUE' requests a fresh copy.

Usage

microdados_baixar(
  sistema,
  tipo = NULL,
  ano,
  mes = NULL,
  uf = NULL,
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  preliminares = TRUE,
  verificar = TRUE,
  timeout = 240
)

Arguments

Value

A data frame describing the local files. Use [datasus_proveniencia()] for URLs and checksums.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
files <- microdados_baixar("sih", ano = 2024, mes = 1, uf = "AC")
datasus_proveniencia(files)
})
options(old_options)

Description

Returns the local catalog of raw DBC/DBF file families supported by the package. These files provide record-level data, unlike aggregated TABNET results.

Usage

microdados_catalogo(sistema = NULL)

Arguments

Value

A data frame with system, upstream source, file type, description, geographic scope and frequency.

Examples

microdados_catalogo()
microdados_catalogo("sih")

Description

Downloads the requested DBC files and reads them directly in memory using the native 'datasusr' decoder. Column selection and 'n_max' are applied during parsing, which is useful for large SIH files.

Usage

microdados_ler(
  sistema,
  tipo = NULL,
  ano,
  mes = NULL,
  uf = NULL,
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  preliminares = TRUE,
  verificar = TRUE,
  timeout = 240,
  colunas = NULL,
  n_max = Inf,
  normalizar = FALSE,
  juntar = TRUE,
  ...
)

Arguments

Value

A data frame, or a named list when 'juntar = FALSE', with provenance metadata attached.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
admissions <- microdados_ler(
  "sih",
  ano = 2024,
  mes = 1,
  uf = "AC",
  colunas = c("MUNIC_RES", "DT_INTER", "DIAG_PRINC", "VAL_TOT"),
  n_max = 1000,
  normalizar = TRUE
)
})
options(old_options)

Description

Validates current territorial identifiers against the bundled IBGE reference. Municipality inputs may use the full seven-digit IBGE code or the six-digit form commonly returned by DATASUS. State and region inputs may also use abbreviations or full names.

Usage

normalizar_codigo_ibge(
  codigo,
  nivel = c("municipio", "uf", "regiao"),
  formato = NULL,
  desconhecido = c("erro", "na", "manter")
)

Arguments

Value

A character vector with the same length as 'codigo'.

Examples

normalizar_codigo_ibge(c("500270", "5003702"))
normalizar_codigo_ibge(c("MS", "Mato Grosso do Sul"), "uf", "ibge")

Description

Downloads annual records from the e-SUS Notifica Hospital Admissions module. The published files cover SUS clinical and intensive-care beds allocated to suspected or confirmed COVID-19 cases. Fields added in 2022 are not populated in earlier records.

Usage

ocupacao_hospitalar(
  ano = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  colunas = NULL,
  normalizar = FALSE,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource with provenance metadata.

References

OpenDataSUS. Registro de Ocupação Hospitalar COVID-19. https://dadosabertos.saude.gov.br/dataset/registro-de-ocupacao-hospitalar-covid-19

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
leitos <- ocupacao_hospitalar(ano = 2022, n_max = 1000)
})
options(old_options)

Description

Some OpenDataSUS resources, notably state-level influenza-like illness datasets, publish several file parts as links inside the resource description instead of the primary URL field. This function expands both representations to one row per downloadable file.

Usage

opendatasus_arquivos(
  conjunto,
  recurso = NULL,
  formato = NULL,
  cache = TRUE,
  atualizar = FALSE
)

Arguments

Value

A data frame with one row per downloadable file and its parent resource identifier, part number and URL.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
opendatasus_arquivos(
  "notificacoes-de-sindrome-gripal-leve-2024",
  recurso = "Dados MS - 20/12",
  formato = "CSV"
)
})
options(old_options)

Description

Resolves a resource from the live portal metadata, downloads it atomically and records its origin and MD5 checksum. By default, files are reused from the package cache. A cached file is refreshed automatically when the resource update timestamp changes.

Usage

opendatasus_baixar(
  conjunto,
  recurso = NULL,
  ano = "last",
  formato = NULL,
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE
)

Arguments

Value

The normalized local file path, with classes '"datasus_arquivo"' and '"character"'. Use [datasus_proveniencia()] to inspect its origin.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
file <- opendatasus_baixar(
  "arboviroses-dengue",
  ano = 2025,
  formato = "CSV"
)
datasus_proveniencia(file)
})
options(old_options)

Description

Searches the current OpenDataSUS portal and returns lightweight metadata for matching datasets. Use [opendatasus_recursos()] to inspect the files and API links published for one dataset.

Usage

opendatasus_catalogo(
  busca = NULL,
  grupo = NULL,
  formato = NULL,
  pagina = 1L,
  limite = 20L,
  cache = TRUE,
  atualizar = FALSE
)

Arguments

Value

A data frame with dataset names, titles, descriptions, formats and groups. Attribute '"datasus_proveniencia"' records the source and consultation time.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
opendatasus_catalogo("dengue")
opendatasus_catalogo(grupo = "arboviroses", formato = "CSV")
})
options(old_options)

Description

Selects and downloads one CSV or JSON resource, then reads it into R. CSV delimiters are detected automatically. For very large datasets, use 'n_max' while exploring the columns, or call [opendatasus_baixar()] and use a streaming database engine.

Usage

opendatasus_ler(
  conjunto,
  recurso = NULL,
  ano = "last",
  formato = NULL,
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  colunas = NULL,
  ...
)

Arguments

Value

The parsed resource. Attribute '"datasus_proveniencia"' records the selected resource, download time, local file and checksum.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
dengue <- opendatasus_ler(
  "arboviroses-dengue",
  ano = 2025,
  formato = "CSV",
  n_max = 1000
)
datasus_proveniencia(dengue)
})
options(old_options)

Description

Downloads the selected resource using the regular atomic cache, expands multipart resources, and invokes a callback for bounded-size chunks. Returning small summaries or 'NULL' from the callback keeps memory use independent of the complete dataset size.

Usage

opendatasus_processar(
  conjunto,
  FUN,
  recurso = NULL,
  ano = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  colunas = NULL,
  tamanho_bloco = 100000L,
  sistema = NULL,
  ...
)

Arguments

Value

An object of class '"datasus_processamento"' containing callback results, row, chunk and file counts, and provenance for every file.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
summary <- opendatasus_processar(
  "doses-aplicadas-pelo-programa-de-nacional-de-imunizacoes-pni-2026",
  recurso = "Vacinação - Julho 2026",
  ano = NULL,
  formato = "CSV",
  FUN = function(dados, posicao, arquivo) nrow(dados),
  tamanho_bloco = 50000
)
})
options(old_options)

Description

List resources from an OpenDataSUS dataset

Usage

opendatasus_recursos(conjunto, cache = TRUE, atualizar = FALSE)

Arguments

Value

A data frame with one row per published resource, including its stable identifier, name, format, inferred year, URL and update date.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
opendatasus_recursos("srag-2019-a-2026")
opendatasus_recursos("arboviroses-dengue")
})
options(old_options)

Description

Calculates a weighted average of age-specific rates using a supplied standard population. Independent Poisson counts are assumed for the standard error. Optional confidence limits use a normal approximation.

Usage

padronizar_idade(
  eventos,
  populacao,
  idade,
  populacao_padrao,
  grupo = NULL,
  multiplicador = 1e+05,
  confianca = NULL,
  na_rm = FALSE
)

Arguments

Value

A data frame with standardized rate, standard error, confidence limits, number of strata and proportion of standard weight represented.

References

Ahmad OB et al. (2001). Age standardization of rates: a new WHO standard. World Health Organization.

Examples

padronizar_idade(
  eventos = c(10, 40),
  populacao = c(1000, 1000),
  idade = c("0-49", "50+"),
  populacao_padrao = c("0-49" = 800, "50+" = 200)
)

Description

Downloads anonymous vaccination records published in monthly files by the National Immunization Program. This record-level source complements the aggregated historical TABNET series returned by [pni_imunizacoes()].

Usage

pni_doses(
  ano = "last",
  mes = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  colunas = NULL,
  normalizar = FALSE,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource with provenance metadata.

References

OpenDataSUS. Doses aplicadas pelo Programa Nacional de Imunizações. https://dadosabertos.saude.gov.br/dataset?query=doses+aplicadas+PNI

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
doses <- pni_doses(ano = 2025, mes = 1, n_max = 1000)
})
options(old_options)

Description

Provides applied doses and vaccination coverage from the legacy TABNET series, whose latest available year is currently 2022. DATASUS reports that coverage and applied-dose data are under review for integration inconsistencies.

Usage

pni_imunizacoes(
  conjunto = "doses_aplicadas",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
pni_imunizacoes(uf = "MS")
pni_imunizacoes(
  conjunto = "cobertura",
  uf = "MS",
  periodo = 2022
)
})
options(old_options)

Description

Returns age-group weights for the WHO 2000–2025 world standard, Segi's world standard or the Scandinavian standard. By default weights are normalized to sum to one and can be passed directly to [padronizar_idade()].

Usage

populacao_padrao(
  nome = "oms_2000_2025",
  formato = c("vetor", "dados"),
  normalizar = TRUE
)

Arguments

Value

A named numeric vector or a data frame with 'faixa_etaria', 'peso_publicado' and 'peso'.

References

Ahmad OB et al. (2001). Age standardization of rates: a new WHO standard. https://cdn.who.int/media/docs/default-source/gho-documents/global-health-estimates/gpe_discussion_paper_series_paper31_2001_age_standardization_rates.pdf

Examples

populacao_padrao("oms")
populacao_padrao("segi", formato = "dados")

Description

Provides census, projection, retroprojection and municipal estimate datasets published in the DATASUS population section. The default dataset contains municipal estimates by sex and age from 2000 through 2021.

Usage

populacao_residente(
  conjunto = "estimativa_municipal",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
populacao_residente(uf = "MS", periodo = 2021)
populacao_residente(
  linha = "Unidade da Federação",
  periodo = c(2020, 2021)
)
})
options(old_options)

Description

Calculate grouped proportions

Usage

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

Arguments

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")

Description

Epidemiological weeks run from Sunday through Saturday. Week 1 is the Sunday-to-Saturday week containing at least four days of the new year. Dates near New Year can therefore belong to the previous or following epidemiological year.

Usage

semana_epidemiologica(data)

Arguments

Value

A data frame containing the original date, epidemiological year and week, week start and end, and a stable '"YYYY-Www"' code.

References

Brazilian Ministry of Health, SINAN Epidemiological Calendar: https://portalsinan.saude.gov.br/calendario-epidemiologico

Examples

semana_epidemiologica(as.Date(c("2025-01-01", "2026-01-01")))

Description

Query ambulatory production from SIA/SUS

Usage

sia_producao(
  conjunto = "atendimento",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
sia_producao(uf = "MS")
sia_producao(
  linha = "UF",
  conteudo = "Qtd.aprovada",
  periodo = "last"
)
})
options(old_options)

Description

Read SIH hospitalization microdata

Usage

sih_microdados(ano, mes, uf, tipo = "RD", ...)

Arguments

Value

Record-level SIH data.

Description

Provides general morbidity and external-causes views by place of hospitalization or residence. Use 'datasus_catalogo("sih")' and select rows whose category is '"morbidade hospitalar"' to list the datasets.

Usage

sih_morbidade(
  conjunto = "geral_internacao",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
sih_morbidade(uf = "MS")
sih_morbidade(
  uf = "MS",
  linha = "Capítulo CID-10",
  conteudo = "Internações",
  periodo = 2025
)
})
options(old_options)

Description

Query hospital production from SIH/SUS

Usage

sih_producao(
  conjunto = "aih_rd_internacao",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
sih_producao(uf = "MS")
sih_producao(
  uf = "MS",
  linha = "Município",
  conteudo = "Internações",
  periodo = 2025,
  filtros = list(carater_atendimento = "Urgência")
)
})
options(old_options)

Description

Provides a single interface to the mortality tables of the Mortality Information System (SIM). Available datasets are listed by 'datasus_catalogo("sim")'; current row, column, measure, period and filter choices can be inspected with 'datasus_opcoes("sim", ...)'.

Usage

sim(
  conjunto = "obitos",
  abrangencia = c("municipio", "uf"),
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result, with query provenance available through [datasus_proveniencia()].

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
datasus_catalogo("sim")
op <- datasus_opcoes(
  "sim", "obitos", abrangencia = "uf"
)
obitos <- sim(
  conjunto = "obitos",
  abrangencia = "uf",
  periodo = 2024,
  filtros = list(sexo = "Masculino")
)
})
options(old_options)

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes data focused on the regions and states.

Usage

sim_evita10_bruf(linha = "Região", coluna = "Não ativa",
  conteudo = 1, periodo = "last", regiao = "all", unidade_da_federacao = "all",
   causas_evitaveis = "all", capitulo_cid10 = "all", categoria_cid10 = "all",
   faixa_etaria = "all", sexo = "all", cor_raca = "all", escolaridade = "all",
   estado_civil = "all", local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sinasc_nv_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from Midwest region
sim_evita10_bruf(regiao = 5)
})
options(old_options)

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes data focused on brazilian cities.

Usage

sim_evita10_mun(linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", capital = "all",
  cir = "all", macrorregiao_de_saude = "all", microrregiao_ibge = "all",
  ride = "all", territorio_da_cidadania = "all", mesorregiao_pndr = "all",
  amazonia_legal = "all", semiarido = "all", faixa_de_fronteira = "all",
  zona_de_fronteira = "all", municipio_de_extrema_pobreza = "all",
  causas_evitaveis = "all", capitulo_cid10 = "all", categoria_cid10 = "all",
  faixa_etaria = "all", sexo = "all", cor_raca = "all", escolaridade = "all",
  estado_civil = "all", local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sinasc_nv_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the city of Campo Grande/MS
sim_evita10_mun(municipio = 500270)
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes in 0-4 age group data from the states unities.

Usage

sim_evita10_uf(uf, linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", cir = "all",
  macrorregiao_de_saude = "all", divisao_admnist_estadual = "all",
  microrregiao_ibge = "all", ride = "all", causas_evitaveis = "all",
  capitulo_cid10 = "all", categoria_cid10 = "all", faixa_etaria = "all",
  sexo = "all", cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_obt10_mun

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the state of Mato Grosso do Sul
sim_evita10_uf(uf = "ms")
})
options(old_options)

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes data focused on the regions and states and age ranging between 5-74 years old.

Usage

sim_evitb10_bruf(linha = "Região", coluna = "Não ativa",
  conteudo = 1, periodo = "last", regiao = "all", unidade_da_federacao = "all",
  causas_evitaveis = "all", capitulo_cid10 = "all", categoria_cid10 = "all",
  faixa_etaria = "all", faixa_etaria_detalhada = "all", sexo = "all",
  cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_bruf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from Midwest region
sim_evitb10_bruf(region = 5)
})
options(old_options)

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes data focused on brazilian cities and age ranging between 5-74 years old.

Usage

sim_evitb10_mun(linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", capital = "all",
  cir = "all", macrorregiao_de_saude = "all", microrregiao_ibge = "all",
  ride = "all", territorio_da_cidadania = "all", mesorregiao_pndr = "all",
  amazonia_legal = "all", semiarido = "all", faixa_de_fronteira = "all",
  zona_de_fronteira = "all", municipio_de_extrema_pobreza = "all",
  causas_evitaveis = "all", capitulo_cid10 = "all", categoria_cid10 = "all",
  faixa_etaria = "all", faixa_etaria_detalhada = "all", sexo = "all",
  cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_mun

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the city of Campo Grande/MS
sim_evitb10_mun(municipio = 500270)
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to evitable causes in 5-74 age group data from the states unities.

Usage

sim_evitb10_uf(uf, linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", cir = "all",
  macrorregiao_de_saude = "all", divisao_admnist_estadual = "all",
  microrregiao_ibge = "all", ride = "all", causas_evitaveis = "all",
  capitulo_cid10 = "all", categoria_cid10 = "all", faixa_etaria = "all",
  faixa_etaria_detalhada = "all", sexo = "all", cor_raca = "all",
  escolaridade = "all", estado_civil = "all", local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the state of Mato Grosso do Sul
sim_evitb10_uf(uf = "ms")
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to child mortality data focused on focused on the regions and states.

Usage

sim_inf10_bruf(linha = "Região", coluna = "Não ativa",
  conteudo = 1, periodo = "last", regiao = "all",
  unidade_da_federacao = "all", capitulo_cid10 = "all",
  categoria_cid10 = "all", lista_mort_cid10 = "all",
  causa_mal_definidas = "all", causas_evitaveis_0a4anos = "all",
  faixa_etaria_1 = "all", faixa_etaria_2 = "all", faixa_etaria_3 = "all",
  faixa_etaria_4 = "all", faixa_etaria_5 = "all",
  faixa_etaria_detalhada = "all", sexo = "all", cor_raca = "all",
  local_ocorrencia = "all", idade_mae = "all", escolaridade_mae = "all",
  duracao_gestacao = "all", tipo_gravidez = "all", tipo_parto = "all",
  peso_ao_nascer = "all", obito_relacao_parto = "all",
  obito_investigado = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_mun

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from Midwest region
sim_inf10_bruf(regiao = 5)
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to child mortality data focused on brazilian cities.

Usage

sim_inf10_mun(linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", capital = "all",
  cir = "all", macrorregiao_de_saude = "all", microrregiao_ibge = "all",
  ride = "all", territorio_da_cidadania = "all", mesorregiao_pndr = "all",
  amazonia_legal = "all", semiarido = "all", faixa_de_fronteira = "all",
  zona_de_fronteira = "all", municipio_de_extrema_pobreza = "all",
  capitulo_cid10 = "all", categoria_cid10 = "all", lista_mort_cid10 = "all",
  causa_mal_definidas = "all", causas_evitaveis_0a4anos = "all",
  faixa_etaria_1 = "all", faixa_etaria_2 = "all", faixa_etaria_3 = "all",
  faixa_etaria_4 = "all", faixa_etaria_5 = "all", faixa_etaria_detalhada = "all",
  sexo = "all", cor_raca = "all", local_ocorrencia = "all", idade_mae = "all",
  escolaridade_mae = "all", duracao_gestacao = "all", tipo_gravidez = "all",
  tipo_parto = "all", peso_ao_nascer = "all", obito_relacao_parto = "all",
  obito_investigado = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_mun

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the city of Campo Grande/MS
sim_inf10_mun(municipio = 500270)
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to child mortality data from the states unities.

Usage

sim_inf10_uf(uf, linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", cir = "all",
  macrorregiao_de_saude = "all", divisao_admnist_estadual = "all",
  microrregiao_ibge = "all", ride = "all", capitulo_cid10 = "all",
  categoria_cid10 = "all", lista_mort_cid10 = "all",
  causa_mal_definidas = "all", faixa_etaria_1 = "all",
  faixa_etaria_2 = "all", faixa_etaria_3 = "all", faixa_etaria_4 = "all",
  faixa_etaria_5 = "all", faixa_etaria_detalhada = "all",
  sexo = "all", cor_raca = "all", local_ocorrencia = "all",
  idade_mae = "all", escolaridade_mae = "all",
  duracao_gestacao = "all", tipo_gravidez = "all", tipo_parto = "all",
  peso_ao_nascer = "all", obito_relacao_parto = "all",
  obito_investigado = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_evita10_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the state of Mato Grosso do Sul
sim_inf10_uf(uf = "ms")
})
options(old_options)

Description

Read SIM death microdata

Usage

sim_microdados(ano, uf = NULL, tipo = "DO", ...)

Arguments

Value

Record-level SIM data.

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to data focused on the regions and states.

Usage

sim_obt10_bruf(linha = "Região", coluna = "Não ativa",
  conteudo = 1, periodo = "last", regiao = "all", unidade_da_federacao = "all",
  capitulo_cid10 = "all", grupo_cid10 = "all", categoria_cid10 = "all",
  causa_br_cid10 = "all", causa_mal_definida = "all", faixa_etaria = "all",
  faixa_etaria_ops = "all", faixa_etaria_det = "all", faixa_etaria_menor1a = "all",
  sexo = "all", cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sinasc_nv_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from Midwest region
sim_obt10_bruf(region = 5)
})
options(old_options)

Description

This function allows the user to retrieve data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to data focused on brazilian cities.

Usage

sim_obt10_mun(linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", capital = "all",
  cir = "all", macrorregiao_de_saude = "all", microrregiao_ibge = "all",
  ride = "all", territorio_da_cidadania = "all", mesorregiao_pndr = "all",
  amazonia_legal = "all", semiarido = "all", faixa_de_fronteira = "all",
  zona_de_fronteira = "all", municipio_de_extrema_pobreza = "all",
  capitulo_cid10 = "all", grupo_cid10 = "all", categoria_cid10 = "all",
  causa_br_cid10 = "all", causa_mal_definida = "all", faixa_etaria = "all",
  faixa_etaria_ops = "all", faixa_etaria_det = "all", faixa_etaria_menor1a = "all",
  sexo = "all", cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sinasc_nv_uf

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the city of Campo Grande/MS
sim_obt10_mun(municipio = 500270)
})
options(old_options)

Description

This function allows the user to retrive data from SIM's ICD-10 database much in the same way that is done by the online portal. The argument options refer to data from the states unities.

Usage

sim_obt10_uf(uf, linha = "Município", coluna = "Não ativa",
  conteudo = 1, periodo = "last", municipio = "all", cir = "all",
  macrorregiao_de_saude = "all", divisao_admnist_estadual = "all",
  microrregiao_ibge = "all", ride = "all", capitulo_cid10 = "all",
  grupo_cid10 = "all", categoria_cid10 = "all", causa_br_cid10 = "all",
  causa_mal_definida = "all", faixa_etaria = "all", faixa_etaria_ops = "all",
  faixa_etaria_det = "all", faixa_etaria_menor1a = "all", sexo = "all",
  cor_raca = "all", escolaridade = "all", estado_civil = "all",
  local_ocorrencia = "all")

Arguments

Value

The function returns a data frame printed by parameters input.

Lifecycle

This function is deprecated. Use 'sim()' or 'sinasc()' with a named 'filtros' list. The legacy signature is retained for compatibility.

Author(s)

Renato Prado Siqueira [email protected]

See Also

sim_obt10_mun

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
## Requesting data from the state of Mato Grosso do Sul
sim_obt10_uf(uf = "ms")
})
options(old_options)

Description

Supports the disease-specific TABNET datasets listed by 'datasus_catalogo("sinan")'. Because each disease has its own form, inspect dimensions, periods and filters with 'datasus_opcoes("sinan", agravo)'. Febre amarela is not included because its official link points to a separate open-data platform rather than a TABNET form.

Usage

sinan(
  agravo = "dengue",
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
sinan("dengue", uf = "MS")
sinan(
  "violencia_interpessoal_autoprovocada",
  uf = "MS",
  periodo = 2024
)
})
options(old_options)

Description

Downloads the annual OpenDataSUS resources. This complements the aggregated legacy TABNET interface available from 'sinan("dengue")'.

Usage

sinan_dengue(
  ano = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
dengue <- sinan_dengue(ano = 2025, n_max = 1000)
})
options(old_options)

Description

Read current e-SUS SINAN Mpox microdata

Usage

sinan_mpox(
  ano = "last",
  formato = "CSV",
  destino = NULL,
  cache = TRUE,
  atualizar = FALSE,
  n_max = Inf,
  ...
)

Arguments

Value

The parsed OpenDataSUS resource.

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
cases <- sinan_mpox(ano = 2025, n_max = 1000)
})
options(old_options)

Description

Provides a single interface to the Live Birth Information System (SINASC). Current row, column, measure, period and filter choices can be inspected with 'datasus_opcoes("sinasc", ...)'.

Usage

sinasc(
  conjunto = "nascidos_vivos",
  abrangencia = c("municipio", "uf"),
  uf = NULL,
  linha = NULL,
  coluna = NULL,
  conteudo = 1,
  periodo = "last",
  filtros = list()
)

Arguments

Value

A data frame containing the TABNET result, with query provenance available through [datasus_proveniencia()].

Examples

old_options <- options(
  datasus.timeout = 5,
  datasus.download_timeout = 15,
  datasus.max_tries = 1
)
try({
op <- datasus_opcoes(
  "sinasc", abrangencia = "municipio", uf = "SP"
)
nascimentos <- sinasc(
  uf = "SP",
  periodo = 2024,
  filtros = list(sexo = "Masculino")
)
})
options(old_options)