calculate_indicator_not_aggregable_by_time: Calculate a KPI not aggregable by time.

In biggproject/biggr: biggr

Calculate a KPI not aggregable by time.

Description

This function computes the value of a certain indicator that is not aggregable by time (normally, those related to financial).

Usage

calculate_indicator_not_aggregable_by_time(
  indicator,
  annualEnergySavings,
  annualCostSavings,
  affectedBuildingArea,
  investment,
  discountRate,
  lifespan
)

Arguments

indicator	<string> defining the KPI to calculate. Possible values: NormalisedInvestmentCost, AvoidanceCost, SimplePayback, NetPresentValue, ProfitabilityIndex, NetPresentValueQuotient, InternalRateOfReturn.
annualEnergySavings	<float> definining the accumulated energy saving for a whole year.
annualCostSavings	<float> definining the accumulated cost saving for a whole year.
affectedBuildingArea	<float> definining building area affected by the EEM, or project of EEMs.
investment	<float> defining the total initial investment cost of EEM, or project of EEMs.
discountRate	<float> defining the discount rate for the Net Present value. Unit: ratio.
lifespan	<int> defining the lifespan of a EEM, or a project of EEMs.

Value

<float> with the value of the KPI.

biggproject/biggr documentation built on Oct. 2, 2024, 11:13 p.m.