Skip to content

Commit

Permalink
Fix all redirecting urls
Browse files Browse the repository at this point in the history
  • Loading branch information
DavisVaughan committed Nov 3, 2020
1 parent 1360829 commit c15799a
Show file tree
Hide file tree
Showing 81 changed files with 182 additions and 182 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Expand Up @@ -12,8 +12,8 @@ Authors@R:
email = "davis@rstudio.com"))
Maintainer: Sam Boysel <sboysel@gmail.com>
Description: An R client for the 'Federal Reserve Economic Data'
('FRED') API <https://api.stlouisfed.org>. Functions to retrieve
economic time series and other data from 'FRED'.
('FRED') API <https://research.stlouisfed.org/docs/api/>. Functions
to retrieve economic time series and other data from 'FRED'.
License: MIT + file LICENSE
URL: https://github.com/sboysel/fredr
BugReports: https://github.com/sboysel/fredr/issues
Expand Down
4 changes: 2 additions & 2 deletions R/fredr-key.R
Expand Up @@ -16,7 +16,7 @@
#' returns `FALSE`.
#'
#' @param key A valid FRED API key as a string. Obtain one at the [API
#' Keys](https://api.stlouisfed.org/api_key.html) page. Can also be `NULL`
#' Keys](https://research.stlouisfed.org/docs/api/api_key.html) page. Can also be `NULL`
#' to unset the key for the current R session.
#'
#' @details
Expand All @@ -26,7 +26,7 @@
#' setting the key.
#'
#' @references See St. Louis Fed Web Services [API
#' Keys](https://api.stlouisfed.org/api_key.html) to obtain an API key.
#' Keys](https://research.stlouisfed.org/docs/api/api_key.html) to obtain an API key.
#'
#' @seealso Note that by using a FRED API key, you agree to the FRED API [Terms
#' of Use](https://research.stlouisfed.org/docs/api/terms_of_use.html).
Expand Down
2 changes: 1 addition & 1 deletion R/fredr_category.R
Expand Up @@ -7,7 +7,7 @@
#'
#' @section API Documentation:
#'
#' [fred/category](https://research.stlouisfed.org/docs/api/fred/category.html)
#' [fred/category](https://fred.stlouisfed.org/docs/api/fred/category.html)
#'
#' @seealso [fredr_category_children()], [fredr_category_related()],
#' [fredr_category_series()], [fredr_category_tags()], [fredr_category_related_tags()]
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_category_children.R
Expand Up @@ -4,11 +4,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see [Real-Time
#' Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see [Real-Time
#' Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
Expand All @@ -17,7 +17,7 @@
#'
#' @section API Documentation:
#'
#' [fred/category/children](https://research.stlouisfed.org/docs/api/fred/category_children.html)
#' [fred/category/children](https://fred.stlouisfed.org/docs/api/fred/category_children.html)
#'
#' @seealso [fredr_category()], [fredr_category_related()],
#' [fredr_category_series()], [fredr_category_tags()],
Expand Down
8 changes: 4 additions & 4 deletions R/fredr_category_related.R
Expand Up @@ -5,25 +5,25 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
#' @return A `tibble` object containing the name and parent ID for categories
#' related to the category indicated by `category_id`.
#'
#' @details From the [FRED API documentation](https://research.stlouisfed.org/docs/api/fred/category_related.html):
#' @details From the [FRED API documentation](https://fred.stlouisfed.org/docs/api/fred/category_related.html):
#' "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."
#'
#' @section API Documentation:
#'
#' [fred/category/related](https://research.stlouisfed.org/docs/api/fred/category_related.html)
#' [fred/category/related](https://fred.stlouisfed.org/docs/api/fred/category_related.html)
#'
#' @seealso [fredr_category()], [fredr_category_children()],
#' [fredr_category_series()], [fredr_category_tags()], [fredr_category_related_tags()]
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_category_related_tags.R
Expand Up @@ -47,11 +47,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
Expand All @@ -61,7 +61,7 @@
#'
#' @section API Documentation:
#'
#' [fred/category/related_tags](https://research.stlouisfed.org/docs/api/fred/category_related_tags.html)
#' [fred/category/related_tags](https://fred.stlouisfed.org/docs/api/fred/category_related_tags.html)
#'
#' @seealso [fredr_category()], [fredr_category_children()], [fredr_category_related()],
#' [fredr_category_series()], [fredr_category_tags()]
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_category_series.R
Expand Up @@ -46,11 +46,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
Expand All @@ -59,7 +59,7 @@
#'
#' @section API Documentation:
#'
#' [fred/category/series](https://research.stlouisfed.org/docs/api/fred/category_series.html)
#' [fred/category/series](https://fred.stlouisfed.org/docs/api/fred/category_series.html)
#'
#' @seealso [fredr_category()], [fredr_category_children()], [fredr_category_related()],
#' [fredr_category_tags()], [fredr_category_related_tags()]
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_category_tags.R
Expand Up @@ -40,11 +40,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @return A `tibble` object information on tags matching the request and their
#' descriptions. Data include tag name, group ID, popularity, series count, tag
Expand All @@ -54,7 +54,7 @@
#'
#' @section API Documentation:
#'
#' [fred/category/tags](https://research.stlouisfed.org/docs/api/fred/category_tags.html)
#' [fred/category/tags](https://fred.stlouisfed.org/docs/api/fred/category_tags.html)
#'
#' @seealso [fredr_category()], [fredr_category_children()], [fredr_category_related()],
#' [fredr_category_series()], [fredr_category_related_tags()]
Expand Down
4 changes: 2 additions & 2 deletions R/fredr_docs.R
Expand Up @@ -4,13 +4,13 @@
#'
#' @section API Documentation:
#'
#' [FRED API](https://api.stlouisfed.org/docs/fred/)
#' [FRED API](https://fred.stlouisfed.org/docs/api/fred/)
#'
#' @examples
#' if (interactive()) {
#' fredr_docs()
#' }
#' @export
fredr_docs <- function() {
utils::browseURL(url = "https://api.stlouisfed.org/docs/fred/")
utils::browseURL(url = "https://fred.stlouisfed.org/docs/api/fred/")
}
4 changes: 2 additions & 2 deletions R/fredr_endpoints.R
Expand Up @@ -4,15 +4,15 @@
#' \describe{
#' \item{endpoint}{endpoint name (e.g. "fred/category", "fredr/series/observations", "fredr/tags").
#' This name can be supplied to the `endpoint` parameter in [fredr_docs()] to
#' open the [FRED API endpoint documentation](https://api.stlouisfed.org/docs/fred/)
#' open the [FRED API endpoint documentation](https://fred.stlouisfed.org/docs/api/fred/)
#' in a web browser.}
#' \item{type}{endpoint type (e.g. "Categories", "Releases", "Series", "Sources", and "Tags".)}
#' \item{note}{endpoint details}
#' }
#'
#' @section API Documentation:
#'
#' [FRED API](https://api.stlouisfed.org/docs/fred/)
#' [FRED API](https://fred.stlouisfed.org/docs/api/fred/)
#'
#' @seealso [fredr_request()], [fredr_docs()]
"fredr_endpoints"
2 changes: 1 addition & 1 deletion R/fredr_related_tags.R
Expand Up @@ -18,7 +18,7 @@
#'
#' @section API Documentation:
#'
#' [fred/related_tags](https://research.stlouisfed.org/docs/api/fred/related_tags.html)
#' [fred/related_tags](https://fred.stlouisfed.org/docs/api/fred/related_tags.html)
#'
#' @seealso [fredr_category_tags()], [fredr_category_related_tags()], [fredr_docs()],
#' [fredr_release_tags()], [fredr_release_related_tags()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_release.R
Expand Up @@ -4,19 +4,19 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
#' @return A `tibble` object.
#'
#' @section API Documentation:
#'
#' [fred/release](https://research.stlouisfed.org/docs/api/fred/release.html)
#' [fred/release](https://fred.stlouisfed.org/docs/api/fred/release.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release_dates()],
#' [fredr_release_series()], [fredr_release_sources()], [fredr_release_tags()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_release_dates.R
Expand Up @@ -4,11 +4,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to `1776-07-04` (earliest available). For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to `9999-12-31` (latest available). For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param limit An integer limit on the maximum number of results to return.
#' Defaults to `10000`, the maximum.
Expand All @@ -30,7 +30,7 @@
#'
#' @section API Documentation:
#'
#' [fred/release/dates](https://research.stlouisfed.org/docs/api/fred/release_dates.html)
#' [fred/release/dates](https://fred.stlouisfed.org/docs/api/fred/release_dates.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release()],
#' [fredr_release_series()], [fredr_release_sources()], [fredr_release_tags()],
Expand Down
2 changes: 1 addition & 1 deletion R/fredr_release_related_tags.R
Expand Up @@ -13,7 +13,7 @@
#'
#' @section API Documentation:
#'
#' [fred/release/related_tags](https://research.stlouisfed.org/docs/api/fred/release_related_tags.html)
#' [fred/release/related_tags](https://fred.stlouisfed.org/docs/api/fred/release_related_tags.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release()],
#' [fredr_release_dates()], [fredr_release_series()], [fredr_release_sources()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_release_series.R
Expand Up @@ -4,11 +4,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param limit An integer limit on the maximum number of results to return.
#' Defaults to `1000`, the maximum.
Expand Down Expand Up @@ -57,7 +57,7 @@
#'
#' @section API Documentation:
#'
#' [fred/release/series](https://research.stlouisfed.org/docs/api/fred/release_series.html)
#' [fred/release/series](https://fred.stlouisfed.org/docs/api/fred/release_series.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release()],
#' [fredr_release_dates()], [fredr_release_sources()], [fredr_release_tags()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_release_sources.R
Expand Up @@ -4,19 +4,19 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param ... These dots only exist for future extensions and should be empty.
#'
#' @return A `tibble` object.
#'
#' @section API Documentation:
#'
#' [fred/release/sources](https://research.stlouisfed.org/docs/api/fred/release_sources.html)
#' [fred/release/sources](https://fred.stlouisfed.org/docs/api/fred/release_sources.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release()],
#' [fredr_release_dates()], [fredr_release_series()], [fredr_release_tags()],
Expand Down
2 changes: 1 addition & 1 deletion R/fredr_release_tables.R
Expand Up @@ -21,7 +21,7 @@
#'
#' @section API Documentation:
#'
#' [fred/release/tables](https://research.stlouisfed.org/docs/api/fred/release_tables.html)
#' [fred/release/tables](https://fred.stlouisfed.org/docs/api/fred/release_tables.html)
#'
#' @seealso [fredr_releases()], [fredr_release_dates()], [fredr_releases_dates()],
#' [fredr_release()], [fredr_release_series()], [fredr_release_sources()],
Expand Down
2 changes: 1 addition & 1 deletion R/fredr_release_tags.R
Expand Up @@ -11,7 +11,7 @@
#'
#' @section API Documentation:
#'
#' [fred/release/tags](https://research.stlouisfed.org/docs/api/fred/release_tags.html)
#' [fred/release/tags](https://fred.stlouisfed.org/docs/api/fred/release_tags.html)
#'
#' @seealso [fredr_releases()], [fredr_releases_dates()], [fredr_release()],
#' [fredr_release_dates()], [fredr_release_series()], [fredr_release_sources()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_releases.R
Expand Up @@ -2,11 +2,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to today's date. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param limit An integer limit on the maximum number of results to return.
#' Defaults to `1000`, the maximum.
Expand All @@ -28,7 +28,7 @@
#'
#' @section API Documentation:
#'
#' [fred/releases](https://research.stlouisfed.org/docs/api/fred/releases.html)
#' [fred/releases](https://fred.stlouisfed.org/docs/api/fred/releases.html)
#'
#' @seealso [fredr_releases_dates()], [fredr_release()], [fredr_release_dates()],
#' [fredr_release_series()], [fredr_release_sources()], [fredr_release_tags()],
Expand Down
6 changes: 3 additions & 3 deletions R/fredr_releases_dates.R
Expand Up @@ -6,11 +6,11 @@
#'
#' @param realtime_start A `Date` indicating the start of the real-time period.
#' Defaults to the first day of the current year. For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param realtime_end A `Date` indicating the end of the real-time period.
#' Defaults to `9999-12-31` (latest available). For more information, see
#' [Real-Time Periods](https://research.stlouisfed.org/docs/api/fred/realtime_period.html).
#' [Real-Time Periods](https://fred.stlouisfed.org/docs/api/fred/realtime_period.html).
#'
#' @param limit An integer limit on the maximum number of results to return.
#' Defaults to `1000`, the maximum.
Expand All @@ -35,7 +35,7 @@
#'
#' @section API Documentation:
#'
#' [fred/releases/dates](https://research.stlouisfed.org/docs/api/fred/releases_dates.html)
#' [fred/releases/dates](https://fred.stlouisfed.org/docs/api/fred/releases_dates.html)
#'
#' @seealso [fredr_releases()], [fredr_release_dates()], [fredr_release()],
#' [fredr_release_series()], [fredr_release_sources()], [fredr_release_tags()],
Expand Down
4 changes: 2 additions & 2 deletions R/fredr_request.R
Expand Up @@ -27,7 +27,7 @@
#'
#' @section API Documentation:
#'
#' [FRED API](https://api.stlouisfed.org/docs/fred/)
#' [FRED API](https://fred.stlouisfed.org/docs/api/fred/)
#'
#' @examples
#' if (fredr_has_key()) {
Expand Down Expand Up @@ -203,7 +203,7 @@ fredr_download_loop <- function(endpoint, params, retry_times) {
fredr_download <- function(endpoint, params, retry_times) {
httr::RETRY(
verb = "GET",
url = "https://api.stlouisfed.org/",
url = "https://research.stlouisfed.org/docs/api/",
path = paste0("fred/", endpoint),
query = params,
times = retry_times,
Expand Down
2 changes: 1 addition & 1 deletion R/fredr_series.R
Expand Up @@ -11,7 +11,7 @@
#'
#' @section API Documentation:
#'
#' [fred/series](https://research.stlouisfed.org/docs/api/fred/series.html)
#' [fred/series](https://fred.stlouisfed.org/docs/api/fred/series.html)
#'
#' @seealso [fredr_series_observations()], [fredr_series_search_text()],
#' [fredr_series_search_id()], [fredr_series_search_tags()],
Expand Down

0 comments on commit c15799a

Please sign in to comment.