getSimulationNames: Utility function to get simulation's name

View source: R/functions.R

getSimulationNamesR Documentation

Utility function to get simulation's name

Description

Utility function to get simulation's name

Usage

getSimulationNames(pattern, studyPath = NULL, opts = antaresRead::simOptions())

Arguments

pattern

A pattern to match among the simulation.

studyPath

Path to study outputs, used if setSimulationPath is not set.

opts

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

Value

A character vector.

Examples

## Not run: 
getSimulationNames("eco")

## End(Not run)

rte-antares-rpackage/antaresWaterValues documentation built on Feb. 20, 2025, 4:37 p.m.