Package 'obrasgovr'

Retrieve budget commitments

Description

Retrieve budget commitments

Usage

get_commitments(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_empenhos(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("commitments").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing budget commitments and financial execution amounts.

See Also

Other API resources: get_contracts(), get_feasibility_studies(), get_geometries(), get_last_update(), get_physical_execution(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_commitments(id_projeto_investimento = "134851.26-07")
}

---

Retrieve contracts

Description

Retrieve contracts

Usage

get_contracts(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_contratos(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("contracts").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing contracts linked to infrastructure projects.

See Also

Other API resources: get_commitments(), get_feasibility_studies(), get_geometries(), get_last_update(), get_physical_execution(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_contracts(id_projeto_investimento = "134851.26-07")
}

---

Retrieve feasibility studies

Description

Retrieve feasibility studies

Usage

get_feasibility_studies(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_estudos_viabilidade(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("feasibility_studies").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing feasibility studies linked to projects.

See Also

Other API resources: get_commitments(), get_contracts(), get_geometries(), get_last_update(), get_physical_execution(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_feasibility_studies(id_projeto_investimento = "134851.26-07")
}

---

Retrieve geometries

Description

Retrieve geometries

Usage

get_geometries(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_geometrias(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("geometries").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing geometries and territorial identifiers.

See Also

Other API resources: get_commitments(), get_contracts(), get_feasibility_studies(), get_last_update(), get_physical_execution(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_geometries(sg_uf = "PE", page_size = 10)
}

---

Retrieve the data update timestamp

Description

Retrieve the data update timestamp

Usage

get_last_update(base_url = .obrasgovr_base_url())

obter_data_atualizacao(base_url = .obrasgovr_base_url())

Arguments

base_url

HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.

Value

A POSIXct value in the UTC time zone.

See Also

Other API resources: get_commitments(), get_contracts(), get_feasibility_studies(), get_geometries(), get_physical_execution(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_last_update()
}

---

Retrieve physical execution data

Description

Retrieve physical execution data

Usage

get_physical_execution(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_execucao_fisica(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("physical_execution").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing execution percentages, instruments, and dates.

See Also

Other API resources: get_commitments(), get_contracts(), get_feasibility_studies(), get_geometries(), get_last_update(), get_projects(), get_status_history()

Examples

if (interactive()) {
  get_physical_execution(id_projeto_investimento = "134851.26-07")
}

---

Retrieve infrastructure projects

Description

Retrieves infrastructure projects and their nested relationships, including executors, recipients, funding sources, policy areas, and point geometries.

Usage

get_projects(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_projetos(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters accepted by the resource. See the complete list with list_filters("projects"). Filter names and categorical values are kept in Portuguese because they are defined by the ObrasGov API.
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble. One-to-many relationships are preserved in list-columns. Use result_metadata() to inspect pagination information.

See Also

Other API resources: get_commitments(), get_contracts(), get_feasibility_studies(), get_geometries(), get_last_update(), get_physical_execution(), get_status_history()

Examples

if (interactive()) {
  get_projects(uf_principal = "PE", page_size = 10)
}

---

Retrieve project status histories

Description

Retrieves the histories of cancelled or suspended projects, including reasons and remedial actions.

Usage

get_status_history(
  ...,
  page = 1L,
  page_size = 50L,
  all_pages = FALSE,
  page_limit = Inf,
  base_url = .obrasgovr_base_url()
)

obter_historico_situacao(
  ...,
  pagina = 1L,
  tamanho_da_pagina = 50L,
  todas_paginas = FALSE,
  limite_paginas = Inf,
  base_url = .obrasgovr_base_url()
)

Arguments

...	Named filters. See list_filters("status_history").
page	First page to retrieve, starting at 1.
page_size	Number of records per page, between 1 and 200.
all_pages	If TRUE, retrieves successive pages starting at page.
page_limit	Maximum number of pages to retrieve when all_pages is TRUE. Use Inf to retrieve every available page.
base_url	HTTPS base URL. By default, uses the obrasgovr.base_url option or the official API environment.
pagina, tamanho_da_pagina, todas_paginas, limite_paginas	Portuguese aliases for page, page_size, all_pages, and page_limit, respectively. These arguments are available only in the Portuguese function alias.

Value

A tibble containing project status histories.

See Also

Other API resources: get_commitments(), get_contracts(), get_feasibility_studies(), get_geometries(), get_last_update(), get_physical_execution(), get_projects()

Examples

if (interactive()) {
  get_status_history(id_projeto_investimento = "134851.26-07")
}

---

List filters accepted by a resource

Description

Lists the filters published in the OpenAPI contract supported by this package. Unknown filters are rejected before a request is sent to prevent silently incorrect queries. Filter names and categorical values remain in Portuguese because they are part of the upstream API contract.

Usage

list_filters(resource)

obrasgov_filtros(recurso)

Arguments

resource	A resource name returned by list_resources(). Portuguese resource names used by earlier package versions are also accepted.
recurso	Portuguese alias for resource, available only in obrasgov_filtros().

Value

A tibble containing filter names, expected types, and allowed values when applicable.

Examples

list_filters("projects")

---

List available ObrasGov API resources

Description

List available ObrasGov API resources

Usage

list_resources()

obrasgov_recursos()

Value

A tibble containing each resource name, its corresponding function, API endpoint, and whether it is paginated.

Examples

list_resources()

---

Retrieve pagination metadata

Description

Retrieve pagination metadata

Usage

result_metadata(x)

obrasgov_metadados(x)

Arguments

x	A tibble returned by a paginated package function.

Value

A list containing the resource, totals reported by the API, and retrieved pages; NULL for other objects.

Examples

result_metadata(tibble::tibble())

---