gridMetadata

Organize metadata for gridded datasets

Description

gridMetadata objects help define the metadata for an N-dimensional gridded dataset. Each object supports metadata for the following dimensions:

lon: longitude / x-coordinate
lat: latitude / y-coordinate
lev: level / height / z-coordinate
site: non-cartesian spatial coordinate
time: time
run: run / ensemble member
var: climate variable

although datasets are not required to implement all 7 dimensions. The class can also be customized to include additional dimensions or to rename the default dimensions.

gridMetadata objects also include support for non-dimensional metadata via an “attributes” field, which can include data of any type.

Key Methods

The following are the most essential methods for users.

gridMetadata - Create a new gridMetdata object
edit - Edit the metadata for a gridded dataset
index - Return metadata at indexed rows

All User Methods

The complete list of gridMetadata methods for users.

Create / Edit

gridMetadata - Create a new gridMetdata object
edit - Edit the metadata for a gridded dataset
index - Return metadata at specified indices
setOrder - Specify a dimension order for a gridded dataset

Attribute Manipulation

addAttributes - Add non-dimensional attributes to the metadata for a gridded dataset
removeAttributes - Remove attributes from the metadata of a gridded dataset
editAttributes - Replace non-dimensional attributes with new values

List Dimensions

dimensions - Return the list of supported gridMetadata dimensions

defined - Return a list of dimensions with defined metadata

Utilities

Under the hood methods that help the class run. These are not intended for most users.

Console Display

disp - Display gridMetadata object in console

dispAttributes - Display metadata attributes in the console

Assertions

assertField - Throw error if input is not a valid metadata field

assertUnique - Throw error if metadata rows are not unique

Unit Tests

tests - Implement unit tests for the gridMetadata class