From 246786c350a5bb05a2ad85398ebfe27a844c27b3 Mon Sep 17 00:00:00 2001 From: Falk Benke Date: Mon, 21 Oct 2024 17:12:45 +0200 Subject: [PATCH] update documentation --- R/reportCapacity.R | 3 ++- R/reportCapitalStock.R | 3 ++- R/reportEnergyInvestment.R | 3 ++- R/reportLCOE.R | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/R/reportCapacity.R b/R/reportCapacity.R index aba5af5c..9d59f909 100644 --- a/R/reportCapacity.R +++ b/R/reportCapacity.R @@ -11,7 +11,8 @@ #' @param t temporal resolution of the reporting, default: #' t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150) #' @param gdx_ref a GDX object as created by readGDX, or the path to a gdx of the reference run. -#' It is used to guarantee consistency for capacity additions before cm_startyear +#' It is used to guarantee consistency before 'cm_startyear' for capacity variables +#' using time averaging. #' #' @return MAgPIE object - contains the capacity variables #' @author Lavinia Baumstark, Christoph Bertram diff --git a/R/reportCapitalStock.R b/R/reportCapitalStock.R index a767808a..e5026400 100644 --- a/R/reportCapitalStock.R +++ b/R/reportCapitalStock.R @@ -10,7 +10,8 @@ #' @param t temporal resolution of the reporting, default: #' t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150) #' @param gdx_ref a GDX object as created by readGDX, or the path to a gdx of the reference run. -#' It is used to guarantee consistency for capacity additions before cm_startyear +#' It is used to guarantee consistency before 'cm_startyear' for capacity variables +#' using time averaging. #' #' @return MAgPIE object - contains the capital stock variables #' @author Lavinia Baumstark; Michaja Pehl diff --git a/R/reportEnergyInvestment.R b/R/reportEnergyInvestment.R index 42bf2fda..e738e76b 100644 --- a/R/reportEnergyInvestment.R +++ b/R/reportEnergyInvestment.R @@ -11,7 +11,8 @@ #' @param t temporal resolution of the reporting, default: #' t=c(seq(2005,2060,5),seq(2070,2110,10),2130,2150) #' @param gdx_ref a GDX object as created by readGDX, or the path to a gdx of the reference run. -#' It is used to guarantee consistency for investment costs before cm_startyear +#' It is used to guarantee consistency before 'cm_startyear' for investment variables +#' using time averaging. #' #' @return MAgPIE object - contains the price variables #' @author Anastasis Giannousaki diff --git a/R/reportLCOE.R b/R/reportLCOE.R index a06b9c23..08143a42 100644 --- a/R/reportLCOE.R +++ b/R/reportLCOE.R @@ -21,7 +21,8 @@ #' "marginal" (returns only marginal LCOE), "both" (returns marginal and average LCOE) and #' and "marginal detail" (returns table to trace back how marginal LCOE are calculated). #' @param gdx_ref a GDX object as created by readGDX, or the path to a gdx of the reference run. -#' It is used to guarantee consistency for capacity additions and investment variables before cm_startyear +#' It is used to guarantee consistency before 'cm_startyear' for capacity and investment variables +#' using time averaging. #' @return MAgPIE object - LCOE calculated by model post-processing. #' Two types a) standing system LCOE b) new plant LCOE. #' @author Felix Schreyer, Robert Pietzcker, Lavinia Baumstark