Pipe operator

Description

Pipe operator

Usage

lhs %>% rhs

Value

No return value, a utility function to export magrittr pipes to be used in internal package code.

Compound_pipe

Description

Compound_pipe

Usage

lhs %<>% rhs

Value

No return value, a utility function to export magrittr pipes to be used in internal package code.

Dataset containing FIPS codes for counties, states and MSAs.

Description

Built-in dataset to look up areas by FIPS code. Includes recent and historical FIPS codes. To access the data directly, issue the command area_titles).

• area_fips: FIPS code

• area_title: Area name

Usage

data(area_titles)

Format

A data frame with 4723 rows and 2 variables

Note

Last updated 2024-03-13

Basic Request Mechanism for BLS Tables

Description

Return data frame from one or more requests via the US Bureau of Labor Statistics API. Provided arguments are in the form of BLS series ids.

Usage

bls_api(
  seriesid,
  startyear = NULL,
  endyear = NULL,
  registrationKey = NULL,
  catalog = FALSE,
  calculations = FALSE,
  annualaverage = FALSE,
  ...
)

Arguments

Value

A tibble from the BLS API.

Examples

## API Version 1.0 R Script Sample Code
## Single Series request
df <- bls_api("LAUCN040010000000005")

## Not run: 
## API Version 1.0 R Script Sample Code
## Multiple Series request with date params.
df <- bls_api(c("LAUCN040010000000005", "LAUCN040010000000006"), 
startyear = "2010", endyear = "2012")


## API Version 1.0 R Script Sample Code
## Multiple Series request with date params.
df <- bls_api(c("LAUCN040010000000005", "LAUCN040010000000006"), 
startyear = "2010", endyear = "2012")


## API Version 2.0 R Script Sample Code
## Multiple Series request with full params allowed by v2.
df <- bls_api(c("LAUCN040010000000005", "LAUCN040010000000006"),
startyear = "2010", endyear = "2012",
registrationKey = "BLS_KEY", 
calculations = TRUE, annualaverage = TRUE, catalog = TRUE)

## End(Not run)

Return a dataframe of county FIPS codes by state.

Description

Returns a data frame that uses data from the US Census FIPS code list.

Built-in dataset for use with the bls_map function. To access the data directly, issue the command datacounty_fips).

• state: State name

• fips_state: FIPS code for State

• fips_county: FIPS code for County

• county: County name

• type: type

Usage

county_fips(state, ...)

data(county_fips)

Arguments

Format

A data frame with 3235 rows and 5 variables

Value

A tibble from the BLS API.

Note

Last updated 2024-03-13

Examples

## Not run: 
## Get historical USD values based on a 2010 dollar.
values <- county_fips(state = "FL")

## End(Not run)

Dataset containing All items in U.S. city average, all urban consumers, seasonally adjusted CUSR0000SA0.

Description

Built-in dataset to look CPI values by month. Includes recent and historical CPI values. To access the data directly, issue the command cu_main).

• date: Date in yyyy-mm-dd format

• period: Monthly period

• year: CPI year

• value: CPI value

Usage

data(cu_main)

Format

A data frame with 926 rows and 4 variables

Note

Last updated 2024-03-24

Cast a date column to data frame returned by the bls_api() function

Description

A helper function to create a continuous date from Year and Period columns.

Usage

dateCast(api_df = NULL, dt_format = NULL)

Arguments

Value

A tibble from the source api_df with an additional date column based on the date format given in dt_format.

Examples

## Cast a date column to data frame returned by the bls_api() function.
df <- bls_api("LAUCN040010000000005") %>%
dateCast()

Internal function to cast the first letter of a word to upper-case.

Description

Internal function to cast the first letter of a word to upper-case.

Usage

firstupper(x, ...)

Arguments

Value

A string with the first letter of x as capital letter.

Convert the Value of a US Dollar to a Given month on or after 1947.

Description

Returns a data frame that uses data from the Consumer Price Index (All Goods) to convert the value of a US Dollar [$1.00 USD] over time.

Usage

inflation_adjust(base_date = NA, ...)

Arguments

Value

A tibble from the BLS API.

Examples

## Not run: 
## Get historical USD values based on a dollar from Jan 2015.
values <- inflation_adjust(base_year = "2015-01-01")

## End(Not run)

Dataset containing NIACS codes for industry lookups.

Description

Built-in dataset to look up industries by NAICS code. To access the data directly, issue the command naics).

• industry_code: Industry code

• industry_title: Industry title

Usage

data(naics)

Format

A data frame with 2469 rows and 2 variables

Note

Last updated 2024-03-13

Quick employed level

Description

Returns the employment level. SeriesID: LNS12000000 If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_employed_level()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_employed_level()

## End(Not run)

Quick employed rate

Description

Returns the "employment to population ratio." SeriesID: LNS12300000 If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_employed_rate()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_employed_rate()

## End(Not run)

Quick Civilian Labor Force Level

Description

Returns the civilian labor force level. SeriesID: LNS11000000. If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_laborForce_level()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_laborForce_level()

## End(Not run)

Quick Civilian Labor Force Rate

Description

Returns the civilian labor force participation rate. SeriesID: LNS11300000. If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_laborForce_rate()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_laborForce_rate()

## End(Not run)

Quick total nonfarm employment

Description

Returns the Total Nonfarm Payroll Employment, seasonally adjusted. BLS id CES0000000001. If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_nonfarm_employed()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_nonfarm_employed()

## End(Not run)

Quick unemployment level function

Description

Returns the unemployment level. SeriesID: LNS13000000. If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_unemp_level()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_unemp_level()

## End(Not run)

Quick unemployment rate function

Description

Returns the "official" unemployment rate. That is, seasonally adjusted, 16 year and over, or the "U-3" rate. SeriesID: LNS14000000. If you installed a BLS_KEY with the set_bls_key() function, it will detect it and use your key. This counts against your daily query limit.

Usage

quick_unemp_rate()

Value

A tibble from the BLS API.

Examples

## Not run: 
df <- quick_unemp_rate()

## End(Not run)

Search the internal series_id data set.

Description

Search the internal series_id data set.

Usage

search_ids(keyword = NULL, periodicity_code = NULL, ...)

Arguments

Value

A tibble from the the internal data set bls_ids

Examples

## Not run: 
# Search for monthly Unemployment Rates for Women
ids <- search_ids(keyword = c("Unemployment Rate", "Women"), periodicity_code = "M")

## End(Not run)

Dataset containing BLS series ids and descriptions.

Description

Built-in dataset to look up BLS series ids and descriptions. Currently limited to the CPS and LAUS. To access the data directly, issue the command series_ids).

Usage

data(series_ids)

Format

An object of class data.frame with 97813 rows and 4 columns.

Note

Last updated 2024-03-13

Dataset containing size codes for US industries by size.

Description

Built-in dataset to look up industries by size. To access the data directly, issue the command size_titles).

• size_code: Size code

• size_title: Size title

Usage

data(size_titles)

Format

A data frame with 10 rows and 2 variables

Note

Last updated 2024-03-13

Dataset with the lat. / long. of county FIPS codes used for mapping.

Description

Built-in dataset for use with the bls_map function. To access the data directly, issue the command datastate_fips).

• fips_state: FIPS code for state

• state_abb: State abbreviation

• state: State name

• gnisid: Geographic Names Information System ID

Usage

data(state_fips)

Format

A data frame with 57 rows and 4 variables

Note

Last updated 2024-03-13

urlExists

Description

A utility function to run a tryCatch on a URL.

Usage

urlExists(target)

Arguments

Value

A logical of TRUE or FALSE.