Skip to content

v0.4

Compare
Choose a tag to compare
@WesIngwersen WesIngwersen released this 10 Jun 01:02
· 1457 commits to master since this release

A version of useeior capable of building the complete USEEIOv2.0 model along with related model variants. It includes new capabilities of building disaggregated models, of validating and visualizing built models, and significantly enhances model calculation and export. This version includes complete function and data object documentation, model identification and sessionInfo capture, and more thorough logging. This version has been through US EPA internal review and cleared by management.

Model building enhancements

  • Permits model disaggregation for commodity-based models at BEA detail and summary levels with user defined and default allocation rules and embedded configuration and input files; provides associated waste sector disaggregation configuration and input files
  • Adds capability of creating domestic Use tables and associated domestic model component and result matrices through integration of BEA import matrix
  • Adds capability of building satellite tables from flowsa data products in flow-by-sector-collapsed format as .parquet files hosted on the EPA Data Commons or by calling flowsa python library directly via the R reticulate package, or through calling external csv files of existing USEEIO satellite tables reformatted in totals-by-sector format, and subsequently removes embedded static satellite tables
  • Adds capability of integrating indicators from LCIA Formatter LCIA method formatted data products in .parquet format hosted on the EPA Data Commons or by calling the lciafmt python library directly via the R reticulate package, and subsequently removes static LCIA factors for previously used USEEIO methods except for waste type aggregations, jobs and value added
  • Uses local caching for remotely acquired files
  • Creates buildModel wrapper function to build models in a single command along with refactoring of the called model building functions
  • Adds new demand vector specifications and improved functions for defining total consumption, total production, household consumption, and domestic variants from a given final demand table
  • Refactors and improves the matrix nomenclature
  • Adds price adjustment matrices to model object
  • Improves sector crosswalk building and related sector mapping functions
  • Removes some residual model objects at model build time that were used as reference data in model building but were not reflective of the final model
  • Provides cleaner and more extensive logging for modeling building steps and calculations
  • Provides model configuration files for 7 USEEIO models including USEEIOv2.0 and variants

Documentation

  • Provides complete Help documentation for all functions and built-in data objects
  • Provides (outside of R package) format details for models and all included objects, as well as for model specification and disaggregation specification and input files
  • Provides R file first-line comments to describe scope of file

Calculation, Validation, Visualization and Export of Models

  • Adds final perspective calculation (see original USEEIO paper, Yang et al. 2017)
  • Adds analytical sector contribution and flow contribution to impact calculations
  • Provides extensive model validation capability with checks that calculate output and flow totals using model components and compare them to the originals in the input data
  • Adds visualization functions plotMatrixCoefficient, barplotIndicatorScoresbySector, heatmapSatelliteTableCoverage, heatmapSectorRanking, barplotFloworImpactFractionbyRegion and default color schemes for sectors and indicators
  • Adds compareFlowTotals for comparing flows in two models
  • Adds model writing out/export capability for USEEIO API and to .xlsx or .csv format along with with additional session info and model SHA hash-based identifier creation for identifying unique model builds and associating them with user OS, hardware and R configuration

Corrections

  • Corrects price adjustment functions
  • Refactors margin loading to correct use of margin data and avoid double counting

Deprecated

  • Removes deriveMarginSectorImpacts
  • Removes antiquated flow mapping functions
  • Removes generateNonScrapRatios from IO functions and other scrap-adjustment capabilities (scrap is now included as a sector in models)
  • Removes model configuration files for 2010-2016 GHG models (2.0.10.....2.0.16)