rvn_write_Raven_header: Write common Raven file header

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Write common Raven file header

Description

Writes the common Raven file header to file. All lines are Appended.

Usage

rvn_write_Raven_header(
  filename,
  filetype,
  author = NULL,
  creationDate = TRUE,
  textlen = 40
)

Arguments

filename	Name of the file, with extension
filetype	File extension, Encoding, Raven version (e.g. "rvp ASCII Raven 2.9.1")
author	Name of file author (optional)
creationDate	Bool of whether creation date should be added to header. (default TRUE)
textlen	Length of lines (default: 40, used to right-align text)

Value

TRUE	returns TRUE if executed successfully

Author(s)

Leland Scantlebury, [e-mail]

Examples

tf <- file.path(tempdir(), 'HogwartsBasin.rvp')
rvn_write_Raven_header(filename = tf,
                    filetype = 'rvp ASCII Raven 2.9.1',
                    author   = 'Harry Potter')

# view file
readLines(tf)

rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.