bls_overview: Display BLS Dataset Overview
In BLSloadR: Download Time Series Data from the U.S. Bureau of Labor Statistics

bls_overview

R Documentation

Display BLS Dataset Overview

Description

Fetches and displays the overview text file for a BLS dataset. This provides a convenient reference within the R environment without needing to manually find and review the text file on the BLS website.

Usage

bls_overview(
  series_id,
  display_method = "viewer",
  base_url = "https://download.bls.gov/pub/time.series"
)

Arguments

`series_id`	Character string. The BLS series identifier (e.g., "ln", "cu", "ap")
`display_method`	Character string. How to display the overview: "viewer" (default), "console", or "popup"
`base_url`	Character string. Base URL for BLS data (default uses official BLS site)

Value

Invisibly returns the text content. Function is called to use the viewer, console, or as a popup, depending on the 'display_method' argument.

Examples


if(interactive()){
# Display Average Price Data overview
bls_overview("ap")

# Display consumer price index overview  
bls_overview("cu")

# Display in console instead of viewer
bls_overview("ap", display_method = "console")
}

BLSloadR documentation built on April 23, 2026, 9:07 a.m.