Function reference • PFUWorkflow

All functions

agg_metadata: Aggregation groups metadata information

aggregate_products(): Aggregate by product

all_countries: All countries and selected country groups

alloc_graph(): Generate an allocation graph

alloc_plots_df(): Create allocation graphs in a data frame

assemble_eta_fu_tables(): Assemble completed final-to-useful efficiency tables

assemble_fu_allocation_tables(): Assemble completed final-to-useful allocation tables

assemble_phi_u_tables(): Assemble completed phi (exergy-to-energy ratio) tables

cache_info: Cache information

calc_C_mats(): Add allocation matrices to a data frame

calc_eta_fu_phi_u_vecs(): Add efficiency (eta) and exergy-to-energy ratio (phi) vectors to a data frame.

calc_phi_pf_vecs(): Create a data frame of phi_pf vectors

calculate_finaluseful_ex_data(): Create a data frame containing final and useful aggregate energy/exergy data

calculate_fu_ex_product(): Calculate total final consumption of final and useful energy by product

calculate_fu_ex_sector(): Calculate total final consumption of final and useful energy by sector

calculate_fu_ex_total(): Calculate total final consumption of final and useful energy

calculate_p_ex_flow(): Calculate total primary energy by flow

calculate_p_ex_product(): Calculate total primary energy by product

calculate_p_ex_total(): Calculate total energy supply

calculate_primary_ex_data(): Create a data frame containing primary aggregate energy/exergy data

canonical_countries: Canonical countries

clean_targets(): Cleans drake targets

create_fd_sectors_list(): Create a list containing final demand sectors

dir_create_pipe(): Pipe-amenable directory creation

double_counted_countries: Double-counted countries

eta_fu_graph(): Generate an eta_fu graph

eta_fu_plots_df(): Create eta_fu graphs in a data frame

exemplar_lists(): Create exemplar lists from an exemplar table

exemplar_names: Exemplar table names

extract_country_data(): Extract specific country data

generate_eta_fu_template(): Create a final-to-useful efficiencies template

generate_fu_allocation_template(): Create a final-to-useful allocation template

get_L_K_GDP_data(): Create a dataframe containing capital (K), labor (L), and GDP data

get_all_pwt_data(): Get all pwt10 data for a set of countries

get_eta_filepaths(): Get all file paths to machine efficiency files

get_fd_sectors(): Retrieve a list of final demand sectors

get_p_industry_prefixes(): Retrieve primary industry prefixes

get_plan(): Create a drake plan for societal exergy analysis

gross_net_metadata: Gross or Net metadata information

is_balanced(): Tells whether IEA data are balanced

load_country_concordance_table(): Load a country concordance table

load_eta_fu_tables(): Load FU efficiency tables

load_exemplar_table(): Read an exemplar table from an Excel file

load_fu_allocation_tables(): Load FU allocation tables

machine_constants: Information about the machine efficiency files

make_balanced(): Balance IEA data

make_psut(): Convert to PSUT matrices

move_to_exergy(): Move from all exergy quantities to all energy quantities in energy conversion chains

move_to_useful(): Move the last stage of the energy conversion chain from final stage to useful stage

nonstat_alloc_graph(): Generate an allocation graph which contains non-stationary allocations data only

nonstat_alloc_plots_df(): Create non-stationary allocation graphs in a data frame

phi_sources: Sources for phi (exergy-to-energy ratio) data

phi_u_graph(): Generate an phi_u graph

phi_u_plots_df(): Create phi_u graphs in a data frame

product_aggregation_map: A map for aggregating products

read_all_eta_files(): Create a data frame containing machine Eta.fu and Phi.u values.

readd_by_country(): Read a subtarget based on country

release_target(): Save a target to a pinboard.

sample_exemplar_table_path(): Gives a file path to a sample exemplar table

sample_machine_workbook_path(): Gives a file path to a sample machine excel workbook

sea_cols: PFUWorkflow data frame column names

sep_eta_fu_phi_u(): Choose eta.fu or phi.u columns from a data frame of eta.fu and phi.u vectors.

socioecon_cols: Socioeconomic data column names

specify(): Specify the IEA data

stash_cache(): Save the cache to a zip file, then to pipeline_caches_folder

sum_phi_vecs(): Sums phi_pf and phi_u vectors

target_names: Drake cache target names