BEA_DSparams: Get Parameters for a Particular BEA Dataset

In donboyd5/apitools: Tools For Using the BEA and Census APIs

Description

BEA_DSparams returns a data frame with a list of parameters for the particular dataset Pay particular attention to whether a data set will accept multiple table flags, or whether tables must be retrieved one by one

Usage

BEA_DSparams(dsname, key)

Arguments

dsname	text name of the dataset (see BEA_DSlist)
key	Your BEA API key (can be obtained for free - check www.bea.gov)

Details

Queries the BEA API to get list of parameters needed to retrieve data for a particular dataset. Particularly useful datasets are NIPA and NIUnderlyingDetail

Value

data frame with columns: "ParameterName" "ParameterDataType" "ParameterDescription" "ParameterIsRequiredFlag" "MultipleAcceptedFlag" "AllValue" "ParameterDefaultValue"

Examples

bea.param <- BEA_DSparams("NIPA") # don't need to give it a key if you have yours set
BEA_DSparams("NIUnderlyingDetail")
BEA_DSparams("RegionalData")

donboyd5/apitools documentation built on May 15, 2019, 10:38 a.m.