beaSearch: Search a selection of indexed BEA data table names, series...

View source: R/beaSearch.r

beaSearchR Documentation

Search a selection of indexed BEA data table names, series labels, and series codes.

Description

Searches indexed dataset table name, label, and series codes. CAUTION: Currently only searches within NATIONAL datasets (NIPA, NIUnderlyingDetail, FixedAssets).

Usage

beaSearch(searchTerm, beaKey = NULL, asHtml = FALSE)

Arguments

searchTerm

A word or phrase of class 'character' to be found in BEA datasets

beaKey

Character string representation of user API key. Necessary for first time use and updates; recommended for anything beyond one-off searches from the console.

asHtml

Option to return results as DT markup, viewable in browser. Allows search WITHIN YOUR ALREADY-FILTERED RESULTS ONLY. Requires package 'DT' to be installed.

Value

An object of class 'data.table' with information about all indexed sets in which the search term was found.

Examples


beaSearch('gross domestic product', beaKey = Sys.getenv("BEA_API_KEY"), asHtml = TRUE)


us-bea/bea.R documentation built on June 11, 2025, 2:35 p.m.