README.md

In MatthewHeun/SEAPSUTWorkflow: Functions and Workflows for Primary-Final-Useful Societal Exergy Analysis Within the PSUT Framework

SEAPSUTWorkflow

The R package SEAPSUTWorkflow provides functions and drake workflows for Societal Exergy Analysis (SEA) using the Physical Supply Use Table (PSUT) framework.

Installation

You can install SEAPSUTWorkflow from github with:

# install.packages("devtools")
devtools::install_github("MatthewHeun/SEAPSUTWorkflow")

Example

To create a drake workflow, do this:

library(SEAPSUTWorkflow)
get_plan(countries = c("GHA", "ZAF"),
         additional_exemplar_countries = "World",
         max_year = 1999,
         ceda_data_folder = "ceda_path",
         machine_data_path = "machine_path",
         iea_data_path = "iea_path",
         country_concordance_path = "country_concordance_path",
         phi_constants_path = "phi_constants_path",
         exemplar_table_path = "exemplar_path",
         fu_analysis_folder = "fu_folder",
         reports_source_folders = "reports_source_path",
         reports_dest_folder = "reports_dest_path"
         )
#> # A tibble: 47 × 3
#>    target                   command                       dynamic   
#>    <chr>                    <expr_lst>                    <expr_lst>
#>  1 countries                c(c("GHA", "ZAF"))            NA        
#>  2 alloc_and_eff_couns      unique(c(countries, "World")) NA        
#>  3 max_year                 1999                          NA        
#>  4 iea_data_path            "iea_path"                    NA        
#>  5 country_concordance_path "country_concordance_path"    NA        
#>  6 phi_constants_path       "phi_constants_path"          NA        
#>  7 ceda_data_folder         "ceda_path"                   NA        
#>  8 machine_data_path        "machine_path"                NA        
#>  9 exemplar_table_path      "exemplar_path"               NA        
#> 10 fu_analysis_folder       "fu_folder"                   NA        
#> # … with 37 more rows

History

The functions in this package were used in …

More Information

Find more information, including vignettes and function documentation, at https://MatthewHeun.github.io/SEAPSUTWorkflow/.

References

MatthewHeun/SEAPSUTWorkflow documentation built on April 22, 2022, 2:21 p.m.