update documentation

pik-piam · Oct 21, 2024 · 246786c · 246786c
1 parent 7b59dc2
commit 246786c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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