read_results: Read results from *.slf

Description Usage Arguments Value

View source: R/results.R

Description

Reads the results of a TELEMAC simulation from a SELAFIN (*.slf) file.

Usage

1
read_results(fname, vars = "all", times = NULL, return_datetime = FALSE)

Arguments

fname

character File name of the results file to be read.

vars

Selection of variables to be read from the file: either "all" (default) reading all variables, "none" giving only the header, a character vector of variable names, or a numeric vector of positions.

times

integer vector, the timesteps to be read. Passed to read_slf_header.

return_datetime

logical, return timesteps as datetime (POSIXct) object?

Value

A list with header (see output of read_slf_header) and values, which is a tidy data.frame where each line represents the value for a certain mesh point (with coordinates x and y) at a certain simulation timestep (note that this might be difficult to interpret if you used variable timestep lengths) for a specific variable.


tpilz/telemac documentation built on Feb. 10, 2022, 2:12 p.m.