Package {CepalStatR}

Title:	Access to the 'CEPALSTAT API'
Version:	0.9.0
Description:	Explore metadata and retrieve indicators from the statistical portal of the Economic Commission for Latin America and the Caribbean https://statistics.cepal.org/portal/cepalstat/. Provides a reproducible interface to access the 'CEPALSTAT API', organize data into tidy formats, and generate both static and interactive visualizations.
License:	MIT + file LICENSE
URL:	https://github.com/Henry-Osorto/CepalStatR, https://henry-osorto.github.io/CepalStatR/
BugReports:	https://github.com/Henry-Osorto/CepalStatR/issues
Encoding:	UTF-8
Depends:	R (≥ 4.1)
Imports:	base64enc, dplyr, httr2, htmltools, jsonlite, magrittr, reactable, stringr, tidyselect, rlang, collapsibleTree, gridExtra, htmlwidgets
Suggests:	ggplot2, gt, knitr, rmarkdown, svglite, testthat (≥ 3.0.0), vcr, webmockr
VignetteBuilder:	knitr
Config/testthat/edition:	3
RoxygenNote:	7.3.2
NeedsCompilation:	no
Packaged:	2026-05-05 05:00:20 UTC; henry
Author:	Henry Osorto [aut, cre]
Maintainer:	Henry Osorto <henry.osorto@unah.edu.hn>
Repository:	CRAN
Date/Publication:	2026-05-07 16:43:28 UTC

CepalStatR: Access to the 'CEPALSTAT API'

Description

Explore metadata and retrieve indicators from the statistical portal of the Economic Commission for Latin America and the Caribbean https://statistics.cepal.org/portal/cepalstat/. Provides a reproducible interface to access the 'CEPALSTAT API', organize data into tidy formats, and generate both static and interactive visualizations.

Author(s)

Maintainer: Henry Osorto henry.osorto@unah.edu.hn (ORCID)

See Also

Useful links:

• https://github.com/Henry-Osorto/CepalStatR

• https://henry-osorto.github.io/CepalStatR/

• Report bugs at https://github.com/Henry-Osorto/CepalStatR/issues

Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling rhs(lhs).

Call Data Indicators CEPALSTAT

Description

Retrieves indicator data from the CEPALSTAT API in JSON format and returns a data frame with values, dimensions, metadata, and optionally footnotes.

Usage

call.data(id.indicator, language.en = TRUE, notes = FALSE,
                 progress = TRUE, add.indicator.name = TRUE)

Arguments

Value

A data frame with indicator values, dimension labels, and metadata.

Examples

data <- call.data(id.indicator = 4788)
data <- call.data(id.indicator = 4788, language.en = FALSE)
data <- call.data(id.indicator = 4788, notes = TRUE)

Call indicators from CEPALSTAT

Description

Retrieves the thematic tree from the CEPALSTAT API in JSON format and returns a data frame with the hierarchical structure of indicators.

Usage

call.indicators(language.en = TRUE, progress = TRUE)

Arguments

Value

A data frame with the hierarchical thematic structure of CEPALSTAT indicators and the corresponding indicator ID.

Examples

data.indicators <- call.indicators()
data.indicators <- call.indicators(language.en = FALSE)

Internal helper to retrieve CEPALSTAT resources

Description

Internal helper to retrieve CEPALSTAT resources

Usage

cepal_get(url, format = c("json", "csv"), timeout_sec = 60)

List of countries available in CEPALSTAT

Description

Retrieves the list of countries available in CEPALSTAT using the dimensions endpoint of a reference indicator. This approach avoids downloading full datasets and ensures consistency with the API structure.

Usage

countries(language.en = TRUE)

Arguments

Value

A data frame containing the list of countries.

Examples

countries()
countries(language.en = FALSE)

Convert an image file to a data URI

Description

Convert an image file to a data URI

Usage

img_to_data_uri(path)

Arguments

Value

A character string containing a data URI, or NULL if the file does not exist.

Population pyramids

Description

Creates one or multiple population pyramids for a selected country and years using CEPALSTAT population-by-age-and-sex data.

Usage

pyramids(
  country,
  years = 1:31,
  language.en = TRUE,
  color = c("#0C4A61", "#34B0AA"),
  save = FALSE,
  file = NULL,
  format = c("png", "pdf", "svg"),
  height = 5,
  width = 7,
  caption = TRUE,
  progress = TRUE
)

Arguments

Value

Invisibly returns a grob object created by gridExtra::arrangeGrob().

Examples

# Single year
pyramids(country = "Honduras", years = 16)

# Multiple years
pyramids(country = "Honduras", years = c(1, 5, 10, 15))

#' # Save as PNG
pyramids(country = "Honduras",
         years = c(1, 5, 10, 15),
         save = TRUE,
         file = file.path(tempdir(), "pyramids.png"))

# Save as PDF
pyramids(country = "Honduras",
         years = c(1, 5, 10, 15),
         save = TRUE,
         format = "pdf",
         file = file.path(tempdir(), "pyramids.pdf"))

# Save as SVG
pyramids(country = "Honduras",
         years = c(1, 5, 10, 15),
         save = TRUE,
         format = "svg",
         file = file.path(tempdir(), "pyramids.svg"))

Sustainable Development Goals ranking

Description

Creates a ranking chart for a CEPALSTAT indicator belonging to the Sustainable Development Goals (SDG/ODS) dimension, using the latest available data by country.

Usage

ranking.sdg(
  id.indicator,
  language.en = TRUE,
  save = FALSE,
  file = NULL,
  format = c("png", "pdf", "svg"),
  height = 5,
  width = 9,
  size.title = 10,
  title = TRUE,
  caption = TRUE,
  color = "#0C4A61",
  color.gc = "#34B0AA",
  progress = TRUE
)

Arguments

Value

Invisibly returns a ggplot object.

Examples

ranking.sdg(id.indicator = 3682)

ranking.sdg(id.indicator = 3682, language.en = FALSE)

ranking.sdg(id.indicator = 3682,
            save = TRUE,
            file = file.path(tempdir(), "ranking_sdg.png"))

ranking.sdg(id.indicator = 3682,
            save = TRUE,
            format = "pdf",
            file = file.path(tempdir(), "ranking_sdg.pdf"))

ranking.sdg(id.indicator = 3682,
            save = TRUE,
            format = "svg",
            file = file.path(tempdir(), "ranking_sdg.svg"))

CEPALSTAT thematic map of indicators

Description

Creates an interactive thematic tree of CEPALSTAT indicators using collapsibleTree, with the same visual header and footer style as viewer.indicators().

Usage

topic_map(language.en = TRUE, progress = TRUE, open.browser = FALSE)

Arguments

Value

A browsable HTML widget.

Examples

topic_map()

topic_map(language.en = FALSE)

Viewer for CEPALSTAT indicators

Description

Displays an interactive HTML table for browsing the hierarchical structure of CEPALSTAT indicators using call.indicators() as backend.

Usage

viewer.indicators(
  language.en = TRUE,
  progress = TRUE,
  show_search = TRUE,
  striped = TRUE,
  bordered = FALSE,
  compact = FALSE,
  highlight = TRUE,
  full_width = TRUE,
  page_size = 15,
  open.browser = FALSE
)

Arguments

Value

A browsable HTML object containing the header and interactive table.

Examples

viewer.indicators()
viewer.indicators(language.en = FALSE)
viewer.indicators(open.browser = TRUE)

CSS for viewer.indicators header layout

Description

CSS for viewer.indicators header layout

Usage

viewer_indicators_style()

Value

An htmltools style tag.