get_header_item: Retrieve information from an LPJmL input/output file header

In lpjmlkit: Toolkit for Basic LPJmL Handling

Retrieve information from an LPJmL input/output file header

Description

Convenience function to extract information from a header object as returned by read_header() or create_header(). Returns one item per call.

Usage

get_header_item(header, item)

Arguments

header	LPJmL file header as returned by read_header() or create_header().
item	Header information item to retrieve. One of c("name", "version", "order", "firstyear", "nyear", "firstcell", "ncell", "nbands", "cellsize_lon", "scalar", "cellsize_lat", "datatype", "nstep", "timestep", "endian").

Value

Requested header item. Character string in case of "name" and "endian", otherwise numeric value.

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 LPJmL input/output files.

Examples

## Not run: 
# Read file header
header <- read_header("filename.clm")
nyear <- get_header_item(header = header, item = "nyear")

## End(Not run)

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