get_headersize: Determine the size of an LPJmL input/output file header

View source: R/get_headersize.R

get_headersizeR Documentation

Determine the size of an LPJmL input/output file header

Description

Returns the size in bytes of an LPJmL file header based on a header list object read by read_header() or generated by create_header().

Usage

get_headersize(header)

Arguments

header

Header list object as returned by read_header() or create_header().

Value

Integer value giving the size of the header in bytes. This can be used when seeking in the file or to calculate the expected total file size in combination with the number of included data values and the data type.

See Also

  • read_header() for reading a header from an LPJmL input/output file.

  • create_header() for creating a header from scratch.

Examples

## Not run: 
header <- read_header("filename.clm")
size <- get_headersize(header)
# Open file for reading
fp <- file("filename.clm", "rb")
# Skip over file header
seek(fp, size)
# Add code to read data from file

## End(Not run)

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