get_Reward: Get the reward matrix from simulations, mainly used in...
In rte-antares-rpackage/antaresWaterValues: Generating water values for Antares

get_Reward

R Documentation

Get the reward matrix from simulations, mainly used in `Grid_Matrix`

Description

Get the reward matrix from simulations, mainly used in Grid_Matrix

Usage

get_Reward(
  simulation_values = NULL,
  simulation_names = NULL,
  pattern = NULL,
  district_name = "water values district",
  opts = antaresRead::simOptions(),
  correct_monotony = FALSE,
  method_old = TRUE,
  hours = 0:168,
  possible_controls = NULL,
  max_hydro,
  mcyears = "all",
  area = NULL,
  pump_eff = NULL,
  district_balance = "water values district"
)

Arguments

`simulation_values`	Values generated by `runWaterValuesSimulation`
`simulation_names`	generated by `runWaterValuesSimulation`
`pattern`	A pattern to identify simulations.
`district_name`	Name of the district used to store output.
`opts`	List of simulation parameters returned by the function `antaresRead::setSimulationPath`
`correct_monotony`	Binary argument (default to false). True to correct monotony of rewards.
`method_old`	If T, linear interpolation used between simulations reward, else smarter interpolation based on marginal prices
`hours`	If method_old=F, vector of hours used to evaluate costs/rewards of pumping/generating
`possible_controls`	If method_old=F, data.frame week,u of controls evaluated per week
`max_hydro`	data.frame timeId,pump,turb returned by the function `get_max_hydro`, should be hourly values
`mcyears`	Vector of years used to evaluate rewards
`area`	Area used to calculate watervalues
`pump_eff`	Pumping efficiency
`district_balance`	Name of district used to evaluate controls on the stock