Get detailed constitutional transfers by state
Source:R/transferencias.R
get_tc_por_estados_detalhe.RdRetrieves detailed constitutional transfer data by state, with full breakdown of each transfer.
Usage
get_tc_por_estados_detalhe(
p_estado = NULL,
p_ano = NULL,
p_mes = NULL,
p_transferencia = NULL,
use_cache = TRUE,
verbose = FALSE
)
get_tc_by_state_detail(state_code = NULL, year = NULL,
month = NULL, transfer_type = NULL, use_cache = TRUE, verbose = FALSE)Arguments
- p_estado
State code(s) from
get_tc_estados(). Accepts a vector or colon-separated string. Optional.- p_ano
Year(s). Accepts a vector or colon-separated string. Optional.
- p_mes
Month(s). Accepts a vector or colon-separated string. Optional.
- p_transferencia
Transfer type code(s) from
get_tc_transferencias(). Accepts a vector or colon-separated string. Optional.- use_cache
Logical. If
TRUE(default), uses an in-memory cache.- verbose
Logical. If
TRUE, prints the full API URL being called. Useful for debugging or testing in a browser. Defaults togetOption("tesouror.verbose", FALSE).- state_code
State code(s) from
get_tc_estados(). Accepts a vector or colon-separated string. Treasury codes, not IBGE. Optional. Maps top_estado.- year
Year(s). Accepts a vector or colon-separated string. Optional. Maps to
p_ano.- month
Month(s) (1-12). Accepts a vector or colon-separated string. Optional. Maps to
p_mes.- transfer_type
Transfer type code(s) from
get_tc_transferencias(). Accepts a vector or colon-separated string. Optional. Maps top_transferencia.
Value
A tibble with detailed transfer data by state.
Details
All codes are internal Treasury codes (not IBGE). See
get_tc_estados() and get_tc_transferencias() for dictionaries.
get_tc_by_state_detail() is an English alias.
Examples
if (FALSE) { # \dontrun{
estados <- get_tc_estados()
pe_code <- estados$codigo[estados$nome == "Pernambuco"]
detalhe <- get_tc_por_estados_detalhe(p_estado = pe_code, p_ano = 2023)
} # }