add_UKEnergy2000_row_col_meta: Add row, column, row type, and column type metadata

View source: R/utilities.R

add_UKEnergy2000_row_col_metaR Documentation

Add row, column, row type, and column type metadata

Description

Add row, column, row type, and column type metadata

Usage

add_UKEnergy2000_row_col_meta(
  .DF,
  matname_colname = "matname",
  U_name = "U",
  V_name = "V",
  Y_name = "Y",
  product_colname = "Product",
  flow_colname = "Flow",
  industry_type = "Industry",
  product_type = "Product",
  sector_type = "Sector",
  rowname_colname = "rowname",
  colname_colname = "colname",
  rowtype_colname = "rowtype",
  coltype_colname = "coltype"
)

Arguments

.DF

a data frame containing matname_colname.

matname_colname

the name of the column in .DF that contains names of matrices (a string). Default is "matname".

U_name

the name for use matrices (a string). Default is "U".

V_name

the name for make matrices (a string). Default is "V".

Y_name

the name for final demand matrices (a string). Default is "Y".

product_colname

the name of the column in .DF where Product names is found (a string). Default is "Product".

flow_colname

the name of the column in .DF where Flow information is found (a string). The Flow column usually contains the industries involved in this flow. Default is "Flow".

industry_type

the name that identifies production industries and and transformation processes (a string). Default is "Industry".

product_type

the name that identifies energy carriers (a string). Default is "Product".

sector_type

the name that identifies final demand sectors (a string). Default is "Sector".

rowname_colname

the name of the output column that contains row names for matrices (a string). Default is "rowname".

colname_colname

the name of the output column that contains column names for matrices (a string). Default is "colname".

rowtype_colname

the name of the output column that contains row types for matrices (a string). Default is "rowtype".

coltype_colname

the name of the output column that contains column types for matrices (a string). Default is "coltype".

Value

.DF with additional columns named rowname_colname, colname_colname, rowtype_colname, and coltype_colname.

Examples

UKEnergy2000 %>%
  matsindf:::add_UKEnergy2000_matnames(.) %>%
  matsindf:::add_UKEnergy2000_row_col_meta(.)

matsindf documentation built on Aug. 18, 2023, 5:06 p.m.