join_abcd_scenario: Join a data-loanbook object to the abcd and scenario

View source: R/join_abcd_scenario.R

join_abcd_scenarioR Documentation

Join a data-loanbook object to the abcd and scenario

Description

join_abcd_scenario() is a simple wrapper of several calls to ⁠dplyr::join_*()⁠, forming the master dataset to be used in later steps of the analysis.

Usage

join_abcd_scenario(
  data,
  abcd,
  scenario,
  region_isos = r2dii.data::region_isos,
  add_green_technologies = FALSE
)

Arguments

data

A data frame like the output of r2dii.match::prioritize.

abcd

An asset level data frame like r2dii.data::abcd_demo.

scenario

A scenario data frame like r2dii.data::scenario_demo_2020.

region_isos

A data frame like r2dii.data::region_isos (default).

add_green_technologies

Logical vector of length 1. FALSE defaults to outputting only technologies that are present in both data and abcd. Set to FALSE to add rows of all possible green technologies (with 0 production).

Value

Returns a fully joined data frame, linking portfolio, abcd and scenario.

See Also

Other utility functions: summarize_weighted_production()

Examples

installed <- requireNamespace("r2dii.data", quietly = TRUE) &&
  requireNamespace("r2dii.match", versionCheck = "0.1.0", quietly = TRUE) &&
  packageVersion("r2dii.match") >= "0.1.0"

if (installed) {
  library(r2dii.data)
  library(r2dii.match)

  valid_matches <- match_name(loanbook_demo, abcd_demo) %>%
    # WARNING: Remember to validate matches (see `?prioritize`)
    prioritize()

  valid_matches %>%
    join_abcd_scenario(
      abcd = abcd_demo,
      scenario = scenario_demo_2020,
      region_isos = region_isos_demo
    )
}

r2dii.analysis documentation built on Oct. 23, 2023, 5:08 p.m.