Skip to contents

Get SIOPE staff compensation data

Source: R/siope.R
get_siope_remuneracao.Rd

Retrieves compensation data for education professionals. This endpoint has an additional required parameter: mes / month for the specific month within the year.

Usage

get_siope_remuneracao(
  ano,
  periodo,
  mes,
  uf,
  tipo = NULL,
  use_cache = TRUE,
  verbose = FALSE,
  page_size = 1000L,
  max_rows = Inf,
  filter = NULL,
  orderby = NULL,
  select = NULL
)

get_siope_compensation(year, period, month, state, type = NULL,
  use_cache = TRUE, verbose = FALSE,
  page_size = 1000, max_rows = Inf,
  filter = NULL, orderby = NULL, select = NULL)

Arguments

ano

Integer. Year of the data (e.g., 2023). Required.

periodo

Integer. Bimester period (1-6). Required.

mes

Integer. Month of the fiscal year (1-12). Required.

uf

Character. State abbreviation (e.g., "PE"). Required.

tipo

Character. Convenience filter on the entity type, applied server-side via the DS_TIPO column. Accepts "estado"/"uf" or "municipio"/"municipios" (accent- and case-insensitive). Combined with filter via and. Defaults to NULL. type is the English alias.

use_cache

Logical. If TRUE (default), uses an in-memory cache.

verbose

Logical. If TRUE, prints the full API URL.

page_size

Integer. Rows per page for OData pagination. Defaults to 1000.

max_rows

Numeric. Maximum rows to return. Defaults to Inf.

filter

Character. OData $filter expression to narrow results on the server (much faster than downloading everything). Uses OData syntax (e.g., "NOM_MUNI eq 'Recife'", "COD_MUNI eq 2611606"). Combine with and/or. Column names must use the original API names (uppercase), not the snake_case cleaned names. To discover valid names, run a max_rows = 1 query and use toupper(names(result)). Optional.

orderby

Character. OData $orderby expression to sort results (e.g., "NOM_MUNI asc", "NUM_POPU desc"). Uses original API column names (uppercase). Optional.

select

Character vector. Column names to return (reduces payload size). Uses original API column names (e.g., c("NOM_MUNI", "VAL_DECL")). If a column name is invalid the API returns HTTP 400. Optional.

year

Integer. Year. Required. Maps to ano.

period

Integer. Bimester (1-6). Required. Maps to periodo.

month

Integer. Month (1-12). Required. Maps to mes.

state

Character. State abbreviation. Required. Maps to uf.

type

Character. English alias for tipo: "state"/"uf" or "municipality"/"municipalities". Optional, defaults to NULL.

Value

A tibble with 19 columns including compensation categories and values for education professionals.

Details

get_siope_compensation() is an English alias.

See also

Other SIOPE: get_siope_dados_gerais(), get_siope_despesas(), get_siope_despesas_funcao(), get_siope_indicadores(), get_siope_info_complementares(), get_siope_receitas(), get_siope_responsaveis()

Examples

if (FALSE) { # \dontrun{
rem <- get_siope_remuneracao(ano = 2023, periodo = 6, mes = 12, uf = "PE")
} # }