emburden0.6.1 package

Energy Burden Analysis Using Net Energy Return Methodology

aggregate_cohort_data

Aggregate cohort data by census tract and income bracket

backup_db

Backup Production Database

cache_utils

Cache and Database Management Utilities

calculate_weighted_metrics

Calculate Weighted Metrics for Energy Burden Analysis

check_data_sources

Check Available Data Sources

clear_all_cache

Clear all emburden cache and database

clear_dataset_cache

Clear cache for a specific dataset

clear_test_environment

Clear Test Database and Cache

colorize

Colorize Text for Knitted Documents

compare_energy_burden

Compare Energy Burden Between Years

db_exists

Check if Database Exists

dear_func

Calculate Disposable Energy-Adjusted Resources (DEAR)

delete_db

Delete Database (PROTECTED)

detect_database_corruption

Detect potentially corrupted database data

download_and_merge_states

Download and merge data from multiple states

download_census_tract_data

Download census tract data from OpenEI

download_from_zenodo

Download Dataset from Zenodo

download_lead_data

Download LEAD data from OpenEI

download_tracts_from_zenodo

Download Census Tract Data from Zenodo

emburden-package

emburden: Energy Burden Analysis Using Net Energy Return Methodology

energy_burden_func

Calculate Energy Burden

eroi_func

Calculate Energy Return on Investment (EROI)

find_emburden_db

Find emburden_db.sqlite database

get_all_states

Get all state abbreviations

get_cache_dir

Get the emburden cache directory

get_county_fips

Convert county identifiers to FIPS codes

get_database_dir

Get the emburden database directory

get_database_path

Get the full path to the emburden database file

get_dataset_info

Get Dataset Information

get_db_connection

Get Database Connection

get_db_path

Get Database Path

get_income_brackets

Get Available Income Brackets for a Dataset and Vintage

get_state_fips

Get state FIPS codes from abbreviations

get_zenodo_config

Get Zenodo Record Information

harmonize_income_brackets

Harmonize Income Brackets Across Vintages

lead_to_poverty

Aggregate LEAD data by poverty status

list_cohort_columns

List Available Columns in Cohort Data

list_income_brackets

List Available Income Brackets

list_states

List Available States

load_census_tract_data

Load Census Tract Data

load_cohort_data

Load DOE LEAD Tool Cohort Data

neb_func

Calculate Net Energy Burden (NEB)

ner_func

Calculate Net Energy Return (Nh)

print.energy_burden_comparison

Print Comparison Summary

process_lead_cohort_data

Process raw LEAD data into analysis-ready format with energy metrics

raw_to_lead

Process raw LEAD data into clean format

reexports

Objects exported from other packages

standardize_cohort_columns

Standardize cohort column names across vintages

to_big

Format Large Numbers with Thousand Separators

to_billion_dollar

Format Dollar Amounts in Billions

to_dollar

Format Number as Dollar Amount

to_million

Format Numbers in Millions

to_percent

Format Number as Percentage

try_import_to_database

Try to import cohort data to database

try_import_tracts_to_database

Try to import census tract data to database

try_load_from_csv

Try to load cohort data from CSV

try_load_from_database

Try to load cohort data from database

try_load_tracts_from_csv

Try to load census tract data from CSV

try_load_tracts_from_database

Try to load census tract data from database

validate_before_caching

Validate data before caching to database

Calculate and analyze household energy burden using the Net Energy Return aggregation methodology. Functions support weighted statistical calculations across geographic and demographic cohorts, with utilities for formatting results into publication-ready tables. Methods are based on Scheier & Kittner (2022) <doi:10.1038/s41467-021-27673-y>.

  • Maintainer: Eric Scheier
  • License: AGPL (>= 3)
  • Last published: 2026-01-07