write_header: Write LPJmL header object to an LPJmL input (or output) file

In lpjmlkit: Toolkit for Basic LPJmL Handling

Write LPJmL header object to an LPJmL input (or output) file

Description

Write an LPJmL clm header to a file. The header has to be a list following the structure returned by read_header() or create_header(). The function will fail if the output file exists already unless overwrite is set to TRUE.

Usage

write_header(filename, header, overwrite = FALSE)

Arguments

filename	Filename to write header into.
header	The header to be written.
overwrite	Whether to overwrite an existing output file (default FALSE).

Value

Returns filename invisibly.

See Also

• create_header() for creating headers from scratch and for a more detailed description of the LPJmL header format.

• read_header() for reading headers from files.

Examples

## Not run: 
header <- read_header(filename = "old_filename.clm")
write_header(
  filename = "new_filename.clm",
  header = header,
  overwrite = FALSE
)

## End(Not run)

lpjmlkit documentation built on March 31, 2023, 9:35 p.m.