tesouror (version 0.2.2)

get_dca_for_state: Get DCA data for all municipalities of a Brazilian state

Description

Fetches annual accounts (DCA) for every municipality of state_uf, looping over get_dca() with fault tolerance. See get_rreo_for_state() for the rationale and behaviour of on_error.

Usage

get_dca_for_state(
  state_uf,
  an_exercicio,
  no_anexo = NULL,
  include_capital = TRUE,
  on_error = c("warn", "stop", "silent"),
  use_cache = TRUE,
  verbose = FALSE,
  page_size = NULL,
  max_rows = Inf
)
get_annual_accounts_for_state(state_uf, fiscal_year, appendix = NULL,
  include_capital = TRUE, on_error = c("warn", "stop", "silent"),
  use_cache = TRUE, verbose = FALSE,
  page_size = NULL, max_rows = Inf)

Value

A tibble with all successful DCA rows. If any call failed, has an attribute "failed".

Arguments

state_uf

Character. Two-letter UF code (e.g., "PE"). Required.

an_exercicio

Integer. Fiscal year. Required.

no_anexo

Character. Appendix name filter (e.g., "DCA-Anexo I-AB"). Optional.

include_capital

Logical. Include the state capital? Defaults to TRUE.

on_error

Character. "warn" (default), "stop", or "silent".

use_cache

Logical.

verbose

Logical.

page_size

Integer or NULL.

max_rows

Numeric.

fiscal_year

Integer. Fiscal year. Required. Maps to an_exercicio.

appendix

Character. Appendix name filter. Optional. Maps to no_anexo.

Details

get_annual_accounts_for_state() is an English-parameter alias.

See Also

Other SICONFI: get_anexos(), get_dca(), get_entes(), get_extrato(), get_msc_controle(), get_msc_orcamentaria(), get_msc_patrimonial(), get_rgf(), get_rgf_for_state(), get_rreo(), get_rreo_for_state()

Examples

if (FALSE) {
dca_pe <- get_dca_for_state(state_uf = "PE", an_exercicio = 2022)
}