-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreport_data.Rd
49 lines (40 loc) · 1.27 KB
/
report_data.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/functions.R
\name{report_data}
\alias{report_data}
\title{Plot simulation variables comparison and real Ov. cost (for watervalues)}
\usage{
report_data(
simulations,
type = "area",
district_list = "all",
area_list = "all",
timeStep = "annual",
mcyears,
opts,
plot_var,
watervalues_areas,
...
)
}
\arguments{
\item{simulations}{list of simulation names.}
\item{type}{"area" to import areas and "district" to import districts.}
\item{district_list}{list of district to plot. assign "all" to import all districts.}
\item{area_list}{list of area to plot. assign "all" to import all areas.
that contains the all domain to study.}
\item{timeStep}{Resolution of the data to import.}
\item{mcyears}{precise the MC year to plot.
#' Null plot the synthesis. Default NULL}
\item{opts}{List of simulation parameters returned by the function
\code{antaresRead::setSimulationPath}}
\item{plot_var}{list of variables to plot.}
\item{watervalues_areas}{list of areas name that used water values.}
\item{...}{further arguments passed to or from other methods.}
}
\value{
a \code{ggplot} or \code{data.table} object
}
\description{
Plot simulation variables comparison and real Ov. cost (for watervalues)
}