calculate_savings_and_uncertainty: Calculate meter-based savings and associated uncertainty as...

View source: R/calculate_savings_and_uncertainty.R

calculate_savings_and_uncertaintyR Documentation

Calculate meter-based savings and associated uncertainty as per ASHARE Guideline 14

Description

This function calculates meter-based savings achieved and the associated uncertainty.

Usage

calculate_savings_and_uncertainty(
  prediction_df = NULL,
  savings_fraction = 0.1,
  modeled_object = NULL,
  model_summary_statistics = NULL,
  confidence_level = 90
)

Arguments

prediction_df

Model predictions. Output from calculate_model_predictions

savings_fraction

savings fraction value to use in savings uncertainty calculations. Used when prediction_df is set to NULL

modeled_object

List with model results. Output from model_with_SLR, model_with_CP, model_with_HDD_CDD, and model_with_TOWT.

model_summary_statistics

Dataframe with model statistics. Output from calculate_summary_statistics.

confidence_level

Numeric corresponding to the confidence level to be used for savings uncertainty calculation

Value

a list with the following components:

savings_df

a dataframe with savings achieved for each timestamp.

savings_summary_df

a dataframe with total performance perioenergy use, total adjusted baseline use, total savingsachieved , savings percentage, savings uncertainty, savings percentage using 50 percent uncertainty, and the specified confidence level


kW-Labs/nmecr documentation built on May 6, 2024, 9:28 p.m.