load_electricity_heat_output: Extract a data frame of electricity and heat output...

In MatthewHeun/IEATools: Tools for Working with International Energy Agency Data

Extract a data frame of electricity and heat output information

Description

Extract a data frame of electricity and heat output information

Usage

load_electricity_heat_output(
  .iea_file = NULL,
  electricity_output_prefix = IEATools::elec_heat_output$electricity_output_prefix,
  heat_output_prefix = IEATools::elec_heat_output$heat_output_prefix,
  country = IEATools::iea_cols$country,
  year = IEATools::iea_cols$year,
  flow = IEATools::iea_cols$flow,
  product = IEATools::iea_cols$product,
  e_dot = IEATools::iea_cols$e_dot,
  input_colname = IEATools::elec_heat_output$input_product,
  output_colname = IEATools::elec_heat_output$output_product,
  machine_colname = IEATools::template_cols$machine,
  unit_colname = IEATools::iea_cols$unit,
  unit = "TJ",
  electricity = "Electricity",
  output_machine_delimiter = IEATools::elec_heat_output$output_machine_delimiter,
  total = IEATools::memo_aggregation_product_prefixes$total,
  memo = IEATools::memo_aggregation_flow_prefixes$memo
)

Arguments

.iea_file	The IEA data file to read
electricity_output_prefix	The prefix for electricity output rows. Default is IEATools::elec_heat_output$electricity_output_prefix.
heat_output_prefix	The prefix for heat output rows. Default is IEATools::elec_heat_output$heat_output_prefix.
country, year, flow, product, e_dot, unit_colname	See IEATools::iea_cols.
input_colname, output_colname, output_machine_delimiter	See IEATools::elec_heat_output.
machine_colname	See IEATools::template_cols.
unit	The desired output unit. Default is "TJ". Best not to change this.
electricity	A string that defines electricity output. Default is "Electricity".
total	See IEATools::memo_aggregation_product_prefixes.
memo	See IEATools::memo_aggregation_flow_prefixes.

Value

A data frame of electricity and heat output data.

Examples

sample_iea_data_path() |> 
  load_electricity_heat_output()

MatthewHeun/IEATools documentation built on Dec. 14, 2024, 12:08 a.m.