set_header_item: Set information in an LPJmL input (or output) file header

In lpjmlkit: Toolkit for Basic LPJmL Handling

Set information in an LPJmL input (or output) file header

Description

Convenience function to set information in a header object as returned by read_header() or create_header(). One or several

Usage

set_header_item(header, ...)

Arguments

header	An LPJmL file header as returned by read_header() or create_header().
...	Named header items to set. Can be one or several of 'name', 'version', 'order', 'firstyear', 'nyear', 'firstcell', 'ncell', 'nbands', 'cellsize_lon', 'scalar', 'cellsize_lat', 'datatype', 'nstep', 'timestep', 'endian'. Parameter 'verbose' can be used to control verbosity, as in create_header().

Value

Header header where header items supplied through the ellipsis have been changed.

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

header <- create_header(
  name = "LPJGRID",
  version = 3,
  order = 1,
  firstyear = 1901,
  nyear = 1,
  firstcell = 0,
  ncell = 67420,
  nbands = 2,
  cellsize_lon = 0.5,
  scalar = 1.0,
  cellsize_lat = 0.5,
  datatype = 3,
  nstep = 1,
  timestep = 1,
  endian = .Platform$endian,
  verbose = TRUE
)

header
# $name
# [1] "LPJGRID"
#
# $header
#      version        order    firstyear        nyear    firstcell        ncell
#          3.0          1.0       1901.0          1.0          0.0      67420.0
#        nbands cellsize_lon       scalar cellsize_lat     datatype       nstep
#          2.0          0.5          1.0          0.5          3.0          1.0
#     timestep
#          1.0
#
# $endian
# [1] "little"

# Change number of cells to 1
set_header_item(header = header, ncell = 1)
# $name
# [1] "LPJGRID"
#
# $header
#      version        order    firstyear        nyear    firstcell        ncell
#          3.0          1.0       1901.0          1.0          0.0          1.0
#        nbands cellsize_lon       scalar cellsize_lat     datatype       nstep
#          2.0          0.5          1.0          0.5          3.0          1.0
#     timestep
#          1.0
#
# $endian
# [1] "little"

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