ESS-DIVE Documentation
  • ESS-DIVE Documentation
  • Frequently Asked Questions
  • Submit Data
    • Get Started
      • Large Data Support
    • Register to Submit Data
    • Data Reporting Formats
    • Submit Data with Online Form
    • Submit Data with Dataset API
    • Link to External Data Sources
  • Publish Data
    • Check Dataset Metadata Quality
    • Dataset and DOI Status Badges
    • Review Cycle and Criteria
      • Metadata Requirements
      • Reporting Format Requirements
    • Publish your Dataset
      • Request Publication
      • Reserve DOI Before Publication
      • Publish with Existing DOI
      • Troubleshooting
  • Manage Data
    • Register Dataset Citations
    • Create Data Portals
      • How to Create & Publish Portals
    • Share Data Permissions
      • Share Datasets
      • Share Portals
    • Manage Project Data
      • Project Data Managers
      • Project Information
      • Project Teams
  • Search & Download Data
    • Search for Data
    • Download Data
    • Access Data Portals
    • Search with Dataset API
      • Code Examples
    • Search with Deep Dive API
      • How to Query Data
  • Programmatic Tools
    • ESS-DIVE Dataset API
      • R Example
      • Python Example
      • Java Example
      • API Updates and Changes
    • Globus Data Transfer Service
      • Setup Globus
      • Upload Data with Globus
      • FAQs
Powered by GitBook
On this page
  • Reporting Format Checks
  • Example Datasets Using Reporting Formats and Successfully Parsed By Fusion Database
  1. Publish Data
  2. Review Cycle and Criteria

Reporting Format Requirements

This page provides an overview of the review process for datasets utilizing reporting formats.

PreviousMetadata RequirementsNextPublish your Dataset

Last updated 1 month ago

ESS-DIVE’s are designed to make data and metadata published on ESS-DIVE more FAIR (Findable, Accessible, Interoperable, Reusable). Consistent formatting of data and metadata enables both machines and humans to better understand and reuse valuable data.

We use reporting formats to enable advanced search within data files. Specifically, the validates, extracts and indexes data within standardized files.

The contents of public data and metadata files successfully parsed by the FusionDB are made searchable by the , which is separate from the ESS-DIVE main search and . This currently requires the use of the and Reporting Formats. These reporting formats are widely applicable to data types stored on ESS-DIVE and ensure that data files are described through standardized metadata fields and are machine-readable. The Fusion DB provides feedback to the ESS-DIVE Publication Review Team if any requirements are not met. These requirements are outlined below. For more detailed documentation of all Reporting Formats, please .

We plan to expand the FusionDB to incorporate data-type specific reporting formats and associated automated validations in the future.

Reporting Format Checks

A series of checks are performed during the publication review process for datasets using reporting formats. Checks listed as required are necessary for machine readability and parsing, whereas strongly recommended and optional checks are recommended enhancements to metadata.

Example datasets that have passed all reporting format checks are available .

Check Name
Requirement Level
Description

File Name

Required

File name uses only letters, numbers, and underscores. Do not include spaces and do not start with an underscore or hyphen.

File Description

Required

A brief description (minimum 10 characters) is provided

Column or Row Name

Required

Column or row names use only letters, numbers, hyphens, and underscores. Do not include spaces, and do not start with an underscore, hyphen, or number.

Unit

Required

Unit is present

Definition

Required

Description is present

Character Set

Required

All characters are within US-ASCII character set without extensions or UTF-8

Delimiter

Required

Delimiter used for file is comma and saved as a CSV file

Data Matrix

Required

Contents of the data portion of the file is organized in a logical and readable matrix format

Column or Row Name Orientation

Required

Orientation of the file is either horizontal or vertical

Consistent Values

Required

Text and numeric data are not mixed within the same Column or Row

Missing Value Codes

Required

All cells in the data matrix have a value and missing data are represented with Missing Value Codes

Temporal Data

Required

Date format follows ISO 8601 standard (YYYY-MM-DD, to known precision) and time format following Coordinated Universal Time (UTC) (YYYY-MM-DD hh:mm:ss, to known precision)

Spatial Data

Required

Geographic coordinates are provided in WGS84 decimal format

File naming conventions for File Level Metadata and Data Dictionary files

Required

A file within the dataset contains the following suffixes *_flmd.csv and *_dd.csv.

Reporting Format Keywords

Required

Standard

Strongly Recommended

Data Orientation

Optional

Check whether “horizontal” or “vertical” is provided within File Level Metadata file

Example Datasets Using Reporting Formats and Successfully Parsed By Fusion Database

ESS-DIVE are used. The File Level Metadata reporting format keyword is required for the FusionDB to identify, validate and parse your dataset.

ESS-DIVE for reporting formats are used

Roley et al., (2023) Data and scripts associated with "Coupled primary production and respiration in a large river contrasts with smaller rivers and streams."

Jastrow et al., (2022) Spatially Averaged Ice Contents of Ice-Wedge Polygon Cross-Sections to 3-m Depth, July 2013, Utqiagvik, Alaska

Kaufman et al., (2023) Spatial Study 2022: Water Column, Sediment, and Total Ecosystem Respiration Rates across the Yakima River Basin, Washington, USA

Gooseff et al., (2023) Riverbed and Near-Surface Water Quality Data, Hanford Reach, Columbia River, February 2021 - April 2022

Hassett et al., (2023) Carbon flux measurements from chambers collected between July to October 2022 at Old Woman Creek, Huron, Ohio

Stolze et al., (2024) Aerobic respiration controls on shale weathering, Geochimica et Cosmochimica Acta, 2023: Dataset

Wang et al., (2024) Continuous soil temperature measurements from 2019-10-4 to 2020-10-4, Teller road Mile 27, Seward Peninsula, Alaska

Sala et al., (2024) Plot and Tree Characteristics from the 2022-2023 field experiment at Game Ridge, Missoula County, Montana, USA

Williams et al., (2024) Anion Data for the East River Watershed, Colorado (2014-2023)

doi:10.15485/1985922
doi:10.15485/1876898
doi:10.15485/1987520
doi:10.15485/2204421
doi:10.15485/2229438
doi:10.15485/1987859
doi:10.15485/2301692
doi:10.15485/2371850
doi:10.15485/1668054
Reporting Formats
Fusion Database (Fusion DB)
Deep Dive API
Dataset API
File Level Metadata (FLMD)
Comma Separated Values (CSV) Guidelines
visit the ESS-DIVE Workspace GitHub
below
reporting format keywords
Standard field terms