fredr (version 1.0.0)

fredr_docs: Open the web documentation for a certain FRED API topic.

Description

Opens FRED API web documentation in a new browser tab.

Usage

fredr_docs(endpoint = "base", params = FALSE, debug = FALSE)

Arguments

endpoint

A string representing the desired documentation for the exact FRED API endpoint. Default is "base", which will open a link to https://api.stlouisfed.org/docs/fred/.

params

A boolean value. If TRUE, the documentation will be opened at the "Parameters" section. Default is FALSE.

debug

A boolean value. If TRUE, the documentation is not opened in a browser and the documentation URL is returned as a string. If FALSE, documentation is opened in a browser and nothing is returned. Default is FALSE.

API Documentation

FRED API

Examples

# NOT RUN {
fredr_docs()
fredr_docs(endpoint = "category")
fredr_docs(endpoint = "series/observations")
fredr_docs(endpoint = "series/observations", params = TRUE)
# }