fredr (version 2.1.0)

fredr_category_related: Get the related categories for a FRED category.

Description

Get the related categories for a FRED category.

Usage

fredr_category_related(
  category_id,
  ...,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

category_id

An integer ID for the category. Default is 0 for the root category. Required parameter.

...

These dots only exist for future extensions and should be empty.

realtime_start

A Date indicating the start of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.

realtime_end

A Date indicating the end of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.

Value

A tibble object containing the name and parent ID for categories related to the category indicated by category_id.

API Documentation

fred/category/related

Details

From the FRED API documentation: "A related category is a one-way relation between 2 categories that is not part of a parent-child category hierarchy. Most categories do not have related categories."

See Also

fredr_category(), fredr_category_children(), fredr_category_series(), fredr_category_tags(), fredr_category_related_tags()

Examples

# NOT RUN {
if (fredr_has_key()) {
# Categories related to the "Employment Cost Index" category
fredr_category_related(category_id = 4L)
}
# }