getStatsFBts: Return a list with statistics summary of the file ts.txt

In rte-antares-rpackage/fbAntares:

Return a list with statistics summary of the file ts.txt

Description

This function takes the object ts, generated with createFBTS and return a list with statistics summary of this object

Usage

getStatsFBts(
  ts,
  calendar = system.file("calendar/calendar.txt", package = "fbAntares"),
  output = "summary"
)

Arguments

ts	data.table The output ts obtained with createFBTS
calendar	character, path to a txt files with two columns, a column Date in the format month-day and a column class with the classes associated to the dates (summer, winter and interSeason).
output	character, the output of you want, either summary, yearbyyear or all, default is summary, if you want the details check the example.

Examples

## Not run: 
ts <- fread(system.file("testdata/antaresInput/ts.txt", package = "fbAntares"),
header = T)
calendar <- system.file("calendar/calendar.txt", package = "fbAntares")
statsFBts <- getStatsFBts(ts, calendar, output = "summary")
statsFBts <- getStatsFBts(ts, calendar, output = "yearbyyear")
statsFBts <- getStatsFBts(ts, calendar, output = "all")

## End(Not run)

rte-antares-rpackage/fbAntares documentation built on June 1, 2022, 6:20 p.m.