blsR (version 0.5.0)

get_n_series_table: Retrieve multiple time series in one API request and return a single tibble

Description

Retrieve multiple time series in one API request and return a single tibble

Usage

get_n_series_table(
  series_ids,
  api_key = bls_get_key(),
  start_year = NULL,
  end_year = NULL,
  year_limit = NULL,
  tidy = FALSE,
  parse_values = TRUE,
  ...
)

Value

a tibble of multiple merged time series

Arguments

series_ids

a list or character vector of BLS time-series IDs. If the items are named then the names will be used in the returned list

api_key

Optional. An API key string. Defaults to the value returned by bls_get_key(). The preferred way to provide an API key is to use bls_set_key() or the BLS_API_KEY environment variable. Manually passing the key will be deprecated in future releases.

start_year, end_year

numeric 4-digit years. While optional, they are strongly recommended. If one is provided, the other is mandatory. end_year must be greater than start_year

year_limit

optional number of years to paginate request by. If not explicitly set, it will be set to 10 or 20 depending on if an api_key is available

tidy

optional boolean. Return will use tidy_periods() if true

parse_values

optional boolean. If set to TRUE (default) it will attempt to parse the contents of value and cast numeric strings as numeric values. If set to FALSE it will retain value as a column of strings.

...

Arguments passed on to get_n_series

series_limit

Maximum number of series to request in one API call when span is set to TRUE.

span

when set to TRUE, requests where the number of years between start_year and end_year exceed year_limit will be performed as multiple requests automatically

See Also

Other blsR-requests: bls_request(), get_all_surveys(), get_latest_observation(), get_n_series(), get_popular_series(), get_series_tables(), get_series_table(), get_series(), get_survey_info(), reduce_spanned_responses(), span_series_request()

Examples

if (FALSE) {
get_n_series_table(
  list(uer.men ='LNS14000001', uer.women = 'LNS14000002'),
  start_year = 2005, end_year=2006
)
}