R/beaParamVals.r

In us-bea/bea.R: Bureau of Economic Analysis API

#' Gives list of values possible for a given dataset's parameters
#'
#' @param beaKey Your API key
#' @param setName Name of BEA dataset (e.g., NIPA)
#' @param paramName Name of BEA dataset parameter (e.g., TableName)
#' @return A metadata object of class 'list' of several dimensions. View list structure using 'str(yourList)'.
#' @keywords metadata
#' @export
#' @examplesIf interactive()  && Sys.getenv("BEA_API_KEY") != ""
#' beaParamVals(Sys.getenv("BEA_API_KEY"), 'NIPA', 'TableName')

beaParamVals <- function(beaKey, setName, paramName) {
	beaMetaSpecs <- list(
		'method' = 'GetParameterValues',
		'UserID' = beaKey,
		'datasetname'=setName,
		'ParameterName'=paramName,
		'ResultFormat' = 'json'
	)
	beaResponse <- bea.R::beaGet(beaMetaSpecs, asList = TRUE, asTable = FALSE, isMeta = TRUE)

	return(beaResponse)
}