# Energy Burden Analysis Using Net Energy Return Methodology

## Documentation for package ‘emburden’ version 0.6.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

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
colorize | Colorize Text for Knitted Documents
compare_energy_burden | Compare Energy Burden Between Years
dear_func | Calculate Disposable Energy-Adjusted Resources (DEAR)
energy_burden_func | Calculate Energy Burden
eroi_func | Calculate Energy Return on Investment (EROI)
get_dataset_info | Get Dataset Information
get_income_brackets | Get Available Income Brackets for a Dataset and Vintage
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
nc_sample | North Carolina Complete Energy Burden Sample Data
neb_func | Calculate Net Energy Burden (NEB)
ner_func | Calculate Net Energy Return (Nh)
orange_county_sample | Orange County NC Energy Burden Sample Data
print.energy_burden_comparison | Print Comparison Summary
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