antaresProcessing (version 0.13)

compare: Compare the surpluses of two simulations

Description

compare has been designed to compare two surpluses created with function surplus but it can be used to compare the values of two tables of class antaresDataTable that contain the same type of data.

Usage

compare(x, y, method = c("diff", "ratio", "rate"))

Arguments

x

Table of class antaresDataTable

y

Table of class antaresDataTable. It must contain the same type of data than 'x': if 'x' contains areas, it must contain areas, ... Moreover it has to have same time step and contain either synthetic or detailed results like 'x'.

method

Method used two compare the two tables. "diff" compute the difference between 'y' and 'x'. "ratio" computes the ratio between 'y' and 'x'. Finally, "rate" computes the rate of change between 'y' and 'x' ( it is equal to the ratio between 'y' and 'x' minus one).

Value

a data.table of class antaresDataTable. It contains all shared rows and columns between 'x' and 'y'. The columns contains the statistic choosen: difference, ratio or rate of change.

Examples

# NOT RUN {
# First simulation
studyPath <- "path/to/study/"

setSimulationPath(studyPath, 1)
mydata1 <- readAntares("all", "all", synthesis = FALSE)
surplus1 <- surplus(mydata1, groupByDistrict = TRUE)

# Second simulation
setSimulationPath(studyPath, 2)
mydata2 <- readAntares("all", "all", synthesis = FALSE)
surplus2 <- surplus(mydata2, groupByDistrict = TRUE)

compare(surplus1, surplus2)
# }
# NOT RUN {
# }