Package index • emburden

Energy Metrics

Core functions for calculating energy burden and related ratios

energy_burden_func(): Calculate Energy Burden
neb_func(): Calculate Net Energy Burden (NEB)
ner_func(): Calculate Net Energy Return (Nh)
eroi_func(): Calculate Energy Return on Investment (EROI)
dear_func(): Calculate Disposable Energy-Adjusted Resources (DEAR)

Data Loading

Functions for loading LEAD Tool data

load_census_tract_data(): Load Census Tract Data
load_cohort_data(): Load DOE LEAD Tool Cohort Data
check_data_sources(): Check Available Data Sources

Cache Management

Functions for managing data cache and database

clear_dataset_cache(): Clear cache for a specific dataset
clear_all_cache(): Clear all emburden cache and database

Metadata Discovery

Functions for exploring available data structure

list_income_brackets(): List Available Income Brackets
get_income_brackets(): Get Available Income Brackets for a Dataset and Vintage
list_states(): List Available States
list_cohort_columns(): List Available Columns in Cohort Data
get_dataset_info(): Get Dataset Information

Statistical Analysis

Weighted aggregation and group-level calculations

calculate_weighted_metrics(): Calculate Weighted Metrics for Energy Burden Analysis
compare_energy_burden(): Compare Energy Burden Between Years
print(<energy_burden_comparison>): Print Comparison Summary

Formatting Utilities

Format numbers for publication-ready tables

to_percent(): Format Number as Percentage
to_dollar(): Format Number as Dollar Amount
to_big(): Format Large Numbers with Thousand Separators
to_million(): Format Numbers in Millions
to_billion_dollar(): Format Dollar Amounts in Billions
colorize(): Colorize Text for Knitted Documents

Sample Data

Bundled datasets for examples and testing

orange_county_sample: Orange County NC Energy Burden Sample Data
nc_sample: North Carolina Complete Energy Burden Sample Data