R/render_report.R

#' Render Weekly Margin Report
#'
#' @param output_file PAth to output file generated.
#' @param date_start Study start date.
#' @param date_study Date for margins computation.
#' @param week Number of the week studied.
#' @param n_scenario Number of scenario used in analysis.
#' @param year_mc Number of the Monte-Carlo year to focus on.
#' @param opts
#'   List of simulation parameters returned by the function
#'   \code{antaresRead::setSimulationPath}  
#'
#' @export
#' 
#' @importFrom rmarkdown render
#' @importFrom utils browseURL
#'
render_report <- function(output_file = "index.html", date_start, date_study, 
                          week, n_scenario, year_mc,
                          opts = antaresRead::simOptions()) {
  output_file <- normalizePath(output_file, mustWork = FALSE)
  suppressWarnings({
    marges <- compute_margins(date = date_study, area = "fr", margin = "upward", opts = opts)
    marges_all <- compute_all_margins(date = date_study, mcYear = year_mc, opts = opts)
    mono <- compute_mono(start = date_start, date = date_study, opts = opts)
  })
  rmarkdown::render(
    input = system.file("markdown/wmauto/index.Rmd", package = "antaresWeeklyMargin"),
    output_file = output_file,
    params = list(
      week = week, 
      n_scenario = n_scenario, 
      year_mc = year_mc, 
      date_study = date_study,
      date_debut = date_start
    )
  )
  browseURL(output_file)
}
rte-antares-rpackage/antaresWeeklyMargin documentation built on May 16, 2019, 8:15 p.m.