update documentation

R/convGDX2MIF_LCOE.R

@@ -23,7 +23,7 @@
 #' @importFrom magclass mbind write.report
 #' @importFrom utils write.table
 
-convGDX2MIF_LCOE <- function(gdx, gdx_ref, file = NULL, scenario = "default",
+convGDX2MIF_LCOE <- function(gdx, gdx_ref = NULL, file = NULL, scenario = "default",
                              t = c(seq(2005, 2060, 5), seq(2070, 2110, 10), 2130, 2150)) {
   # make the reporting
   output <- NULL

R/reportCapacity.R

@@ -11,7 +11,7 @@
 #' @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 Moving Avg prices before cm_startyear
+#' It is used to guarantee consistency for capacity additions before cm_startyear
 #'
 #' @return MAgPIE object - contains the capacity variables
 #' @author Lavinia Baumstark, Christoph Bertram

R/reportCapitalStock.R

@@ -10,7 +10,7 @@
 #' @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 Moving Avg prices before cm_startyear
+#' It is used to guarantee consistency for capacity additions before cm_startyear
 #'
 #' @return MAgPIE object - contains the capital stock variables
 #' @author Lavinia Baumstark; Michaja Pehl

R/reportEnergyInvestment.R

@@ -11,7 +11,7 @@
 #' @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 Moving Avg prices before cm_startyear
+#' It is used to guarantee consistency for investment costs before cm_startyear
 #'
 #' @return MAgPIE object - contains the price variables
 #' @author Anastasis Giannousaki

R/reportLCOE.R

@@ -21,7 +21,7 @@
 #' "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 Moving Avg prices before cm_startyear
+#' It is used to guarantee consistency for capacity additions and investment variables before cm_startyear
 #' @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