-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathplot_reservoir.Rd
42 lines (36 loc) · 1.01 KB
/
plot_reservoir.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Plot_functions.R
\name{plot_reservoir}
\alias{plot_reservoir}
\title{Plot Reservoir Guide Graph and return result table}
\usage{
plot_reservoir(
area,
timeStep = "weekly",
mcyear = NULL,
simulation_name = NULL,
opts = antaresRead::simOptions(),
shiny = F,
only_g = F
)
}
\arguments{
\item{area}{An 'antares' area.}
\item{timeStep}{Resolution of the data to import:
weekly (default, a linear interpolation is done on the data),
monthly (original data).}
\item{mcyear}{precise the MC year to plot.
all to plot all years.
Null plot the synthesis. Default NULL}
\item{simulation_name}{simulation name to plot.}
\item{opts}{List of simulation parameters returned by the function
\code{antaresRead::setSimulationPath}}
\item{shiny}{Boolean. True to run the script in shiny mod.}
\item{only_g}{Boolean. True plot only constraints graph.}
}
\value{
a \code{ggplot} object
}
\description{
Plot Reservoir Guide Graph and return result table
}