writeInputTS: Write input time series

View source: R/writeInputTS.R

writeInputTSR Documentation

Write input time series

Description

Antares API OK

This function writes input time series in an Antares project.

Usage

writeInputTS(
  data,
  type = c("load", "hydroROR", "hydroSTOR", "wind", "solar", "tsLink"),
  area = NULL,
  link = NULL,
  overwrite = TRUE,
  opts = antaresRead::simOptions()
)

Arguments

data

A 8760N matrix of hourly time series, except when type is "hydroSTOR". In this latter case, data must either be 365N (Antares v7) or 12*N (v6 and earlier).

type

Serie to write: "load", "hydroROR", "hydroSTOR", "wind", "solar", or "tsLink".

area

The area where to write the input time series.

link

Link for which writing transmission capacities time series, must like "area01%area02" or c("area01", "area02").

overwrite

Logical. Overwrite the values if a file already exists.

opts

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

Value

An updated list containing various information about the simulation.

Warning

You cannot use area and link arguments at the same time.

Examples

## Not run: 

# Write solar time series
writeInputTS(
  area = "fictive_area",
  type = "solar",
  data = matrix(rep(4, 8760*2), nrow = 8760)
)


## End(Not run)

antaresEditObject documentation built on Dec. 6, 2022, 5:10 p.m.