read_candidates: Read investment candidates with their characteristics

Description Usage Arguments Value

Description

read_candidates is a function which read the investments candidates of the expansion planning problem and their characteristics. The information on the candidates is usually stored in the file antaresStudyPath/user/expansion/candidates.ini.

Usage

1
read_candidates(file, opts = antaresRead::simOptions())

Arguments

file

path toward the text file which contains the candidates description

opts

list of simulation parameters returned by the function antaresRead::setSimulationPath

Value

Returns a list containing the different investment candidates.


rte-antares-rpackage/antaresXpansion documentation built on June 16, 2019, 2:35 p.m.