write_cas: Write steering file (*.cas)

Description Usage Arguments Value Note Examples

View source: R/steering.R

Description

Writes the steering file for a TELEMAC project.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
write_cas(x, ...)

## S3 method for class 'data.frame'
write_cas(x, fname, ...)

## S3 method for class 'list'
write_cas(x, fname, ...)

## S3 method for class 't2d_cas'
write_cas(x, ...)

## S3 method for class 't2d'
write_cas(x, ...)

Arguments

x

Either: An object of class t2d_cas; a list with elements as in a t2d_cas object; a data.frame with columns key and value giving the steering parameters; an object of class t2d with element cas.

...

Arguments passed to or from other methods.

fname

character, a file name (extension .cas) where the steering parameters should be written to.

Value

Returns input x invisibly.

Note

An existing steering file will be silently overwritten.

Examples

1
2
3
4
5
6
7
## Not run: 
# creates test.cas in current working directory
cas_tpl <- cas()
cas_tpl <- cas(cas_tpl, fname = "test.cas")
write_cas(cas_tpl)

## End(Not run)

telemac documentation built on Feb. 19, 2021, 5:08 p.m.