SeaBASS

Metadata Headers

This page provides an overview of the standardized metadata headers used in the SeaBASS (.sb) file format. Metadata headers preserve critical metadata and enable data organization and discoverability. Below is a brief general description of header formatting rules, followed by a comprehensive list and definition of standardized metadata keywords.

General Header Formatting Rules:

• Required Start and End Tags: The block must begin with /begin_header and close with /end_header. The headers between them can be in any order.
• Keyword-Value Pairs: Most headers consist of a keyword (from the standardized lists below) paired with value(s).
  • Example: /delimiter=comma
• No Spaces Allowed: Headers must not contain whitespace. Use underscores (_) rather than spaces.
  • Multiple values: If listing multiple values, comma-separate them without spaces (e.g., /investigators=John_Smith,Mary_Miller).
  • Exception: Freeform comments begin with ! and may contain whitespace (e.g., ! This is a comment).
• Handling Missing Header Values: If a required metadata value is unavailable, use NA (Not Applicable). (Note: Do not use NA in the Data Matrix; use your defined numeric /missing value instead).
• Bracketed Units: Do not use bracketed units in headers, with the sole exception of time and location headers (e.g., [GMT] and [DEG]). All other units are implied by the SeaBASS standard metadata headers dictionaries.
• Time and Location Ranges: The date, time, and location headers must reflect the minimum and maximum bounds of the file (e.g., the earliest time, the farthest north latitude).
• Experiment and Cruise Names: Use consistent names if submitting to an existing project. New names should be selected thoughtfully. These names are very important for data organization and for grouping related datasets. Note: The experiment name is critical as it becomes part of the assigned Digital Object Identifier (DOI).

Header Categories: Many keyword headers are mandatory. However, not all headers are treated equally when creating .sb files:

• Required: Must be included in every SeaBASS file.
• Conditionally Required: Must be included for specific types of measurements.
• Optional: Should be included if relevant, but not required.
• Comments: Freeform comments may be included as lines beginning with !.

Additional information and a full example can be found below.