Skip to contents

Changelog

BLSloadR 0.4.3 patch notes

Hotfix Updates

This patch updates BLSloadR to better address 403 and other download errors with to updates.

  • The download logic now returns NULL and fails gracefully when 400/500 status errors are returned using fread_bls()
  • This version incorporates logic from the development version of the package enabling the user to set a BLS_USER_AGENT environment variable. Using your email address as this will add it to the header request sent to the BLS, which will help to avoid 403 errors in the first place.
  • Documentation updates explaining the environment variables have been added to the README file.

BLSloadR 0.5.2 patch notes

This patch includes a critical fix to resolve rate limit issues downloading data from the BLS. It implements a BLS_USER_AGENT environment variable which is called to populate the file download requests to BLS. Users encountering a 403 error on most requests will need to set this environment variable to ensure smooth downloads. Additional documentation and warning messages will be implemented in a future patch.

BLSloadR 0.5.1 patch notes

Functional Enhancements

explore_cps_characteristics() has been upgraded with a static argument. When set to TRUE it will use a built-in data lookup table to determine available CPS subset codes. Because the BLS mapping files contain codes not in use in the data, this lookup table was built from actual CPS data and will avoid filtering to CPS subsets that do not exist. If this argument is not set or is set to FALSE, this function will continue to infer potential mapping from the live BLS data.

national_cps_availability is a new data table included in the package containing a list and description of filters by which a user may subset the CPS data. When a particular data element is specified it provides a list of data subsetting codes, their description, and other available codes by which this data may be subset further.

BLSloadR 0.5 patch notes

Functional Enhancements

New Data Access Functions

  • This version incorporates new functions to help users work with the national CPS database (“ln”). This is a particularly large database and benefits from the streamlined function introduced in this release, get_cps_subset() - these allow users to pull slices of the full CPS database into a more readable table

New Helper Functions

  • To help users navigate the CPS dataset, functions are introduced to help explore the CPS in two different ways - by the characteristics of the data and by searching for specific series IDs. explore_cps_characteristics() and explore_cps_series() provide console-based access to the CPS data to guide usage of get_cps_subset()

Under-the-hood Improvements

  • This release reflows significant sections of code to improve readability, and also consolidates the creation of headers for sending data requests to the BLS, laying the groundwork to improvement to these headers in the future so they can be more responsive to a user’s actual machine.

  • The package now includes explicit memory cleanup and notifications about large data files and expected memory usage.

  • When working with large files, the data file pre-cleaning now samples 10,000 rows instead of the full file to improve performance.

Documentation Enhancements

  • Help documentation for the new functions has been added, as have help articles to guide users in interacting with the CPS data.

  • A large test suite has been added to the package using testthat for the major functions (both user-facing and background helpers) to identify bugs.

BLSloadR 0.4 patch notes

CRAN release: 2026-02-13

Functional Enhancements

Local File Cache

Because some BLS series update only infrequently, using a local file cache reduces demand for regularly re-downloading data from the BLS.

  • BLSloadR now includes optional local download and retention of files from the BLS. To preserve existing functionality, this is disabled by default. When enabled, BLSloadR checks the local cache for files and compares the date and size of the files to the BLS file to determine if a new file is needed.
  • This introduces two new environment variables to help control file caching
    • BLS_CACHE_DIR can be set to a file path to use as the BLSloadR cache folder. If this is not set, but caching is selected, the system will default to the path given by tools::R_user_dir("BLSloadR", which = "cache")
    • USE_BLS_CACHE can be used to allow functions to default to using the cache, without needing to manually set an argument in each call.
  • To use the file caching, either set the cache=TRUE argument in your function call or set the USE_BLS_CACHE environment variable to “TRUE”

Performance Improvements

In addition to implementing a local file cache, some improvements have been made to the operation of fread_bls() behind the scenes to more efficiently check BLS files for issues like phantom columns. It is becoming evident that with the implementation of a local cache for files this is now the slowest part of the process, so future enhancements may include options to skip some of this processing for files where the BLS file structure is already known and verified.

Added fast_read option in get_oews() to improve function performance. This option pasrses the series_id within the data file instead of reading in the full series file in order to avoid redundant downloads.

Documentation Updates

  • Added vignette documenting use of file cache.

  • Added article describing usage of get_qcew()

BLSloadR 0.3.1 patch notes

Function Enhancements

  • load_bls_dataset():
    • Added the which_data argument to this function, which allows use of this function in a pipeline without needing manual entry in the console for any BLS datasets which have exactly 1 series file and at most 1 aspect file.

Documentation Enhancements

BLSloadR 0.3.0

Major Enhancements

Enhanced CES Functions with Performance Filtering

  • get_ces() - Major performance improvements with new filtering options:
    • states parameter: Download data for specific states only (90%+ faster than full download)
    • industry_filter parameter: Focus on specific industries (retail_trade, manufacturing, etc.)
    • current_year_only parameter: Get only recent data (2006-present) instead of complete history
    • Mutually exclusive filtering prevents conflicting options
  • get_national_ces() - New specialized dataset options for optimal performance:
    • dataset_filter parameter with 4 options: all_data, current_seasonally_adjusted, real_earnings_all_employees, real_earnings_production
    • Up to 95% faster downloads with specialized datasets
    • Enhanced documentation with performance notes
  • get_qcew() - New function designed to access the Quarterly Census of Employment and Wages(QCEW):
    • Get quarterly or annual data for one year or multiple years.
    • Append area and industry definitions to the data.
    • QCEW represents highly detailed data across counties, combined areas, states and national regions.
    • Includes detailed employment and wage data.

New Helper Functions

  • CES Discovery Functions:
  • National CES Discovery Functions:
  • QCEW Lookup Tables included:
    • area_lookup data table has details on QCEW area codes to pre-filter data requests.
    • ind_lookup data table has details on NAICS codes used in QCEW files.

Infrastructure Improvements

  • Fixed URL parameter passing in download_bls_files() (downloads[[‘key’]] vs downloads$key)
  • Consistent parameter naming across functions (suppress_warnings instead of mixed naming)
  • Enhanced error handling and validation throughout
  • Improved diagnostic messaging and user feedback

Documentation and Vignettes

  • New comprehensive vignette: “Working with CES Data: Enhanced Features and Performance”
  • New article on working with OEWS data.
  • Updated main package vignette with enhanced CES capabilities
  • Complete function documentation regeneration
  • Performance comparison tables and best practices

Breaking Changes

  • Parameter show_warnings changed to suppress_warnings in get_national_ces() for consistency
  • Enhanced parameter validation may catch previously ignored invalid inputs

BLSloadR 0.2

CRAN release: 2025-11-25

  • Initial CRAN release.