imf_parameter_defs: Get definitions of IMF API parameters

In christophergandrud/imfr: Download Data from the International Monetary Fund's Data API

Get definitions of IMF API parameters

Description

Get text descriptions of input parameters used in making API requests from a given IMF database

Usage

imf_parameter_defs(database_id, times = 3, inputs_only = T)

Arguments

database_id	character string of a database_id from imf_databases.
times	numeric. Maximum number of API requests to attempt.
inputs_only	logical. Whether to return only parameters used as inputs in API requests, or also output variables.

Value

Returns a data frame of input parameters used in making API requests from a given IMF database, along with text descriptions or definitions of those parameters. Useful in cases when parameter names returned by imf_databases are not self-explanatory. (Note that the usefulness of text descriptions can be uneven, depending on the database design.)

Examples

# Get names and text descriptions of parameters used in IMF API calls to the
# Primary Commodity Price System database
param_defs <- imf_parameter_defs(database_id = 'PCPS')

christophergandrud/imfr documentation built on April 18, 2023, 11:25 a.m.