# Check Dataset Metadata Quality

ESS-DIVE’s **Assessment Reports** provide automated feedback on metadata quality and should be used by dataset creators to assess their metadata before requesting publication. Datasets must pass all required checks to meet ESS-DIVE’s publication requirements (Figure 1).

<figure><img src="https://3166205607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgU7GrufgIOpY1Ufd5R%2Fuploads%2F0tTiLlBI6plpKZ6Hga5x%2FAssessmentReport_Fig1_202510.png?alt=media&#x26;token=8b528319-0833-4684-a8e6-9b42050e95a8" alt=""><figcaption><p>Figure 1. Assessment Report Score and Checks</p></figcaption></figure>

## Assessment Report Automated Review

Dataset metadata undergo an automated review whenever changes are submitted to ESS-DIVE. The automated review uses a standard suite of checks designed based on FAIR (Findable, Accessible, Interoperable, Reusable) data principles (Table 1). The Metadata Assessment Report displays the check results and compiles a score for each FAIR category (e.g. 93/100/100/50).&#x20;

ESS-DIVE reviewers use the Assessment Report scores during the formal review process to assess the quality of metadata before publication. Not all ESS-DIVE dataset publication requirements are contained within the Assessment Report. For a complete list of both manual and automated metadata checks, see the [Dataset Requirements page](https://docs.ess-dive.lbl.gov/publish-data/review-cycle-and-criteria/package-level-metadata).

Before publication, the report is only available to the dataset creator and those who have [shared access to the private dataset](https://docs.ess-dive.lbl.gov/manage-data/share-data-permissions/share-datasets). The Assessment Report becomes available to the public once the dataset is published.

## Check Score while Drafting Metadata

**Before requesting publication for a dataset**, data contributors should review the Assessment Report and address any failed or warning checks. The report provides data contributors immediate feedback on their metadata quality and instructions to revise specific metadata fields. By improving the FAIR category scores before starting a formal review, data contributors **can expedite the overall publication process**.

Please note that assessment reports can take a few minutes, or up to 24 hours, to generate.&#x20;

To access an assessment report, navigate to a dataset landing page on ESS-DIVE and select the "Assessment Report" button on the right-hand side of the landing page (Figure 2).&#x20;

<figure><img src="https://3166205607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgU7GrufgIOpY1Ufd5R%2Fuploads%2F7m75XkMTYpKx2GdJlmyP%2FScreenshot%202023-03-30%20at%2011.20.21%20AM.png?alt=media&#x26;token=c80cc067-3ab3-44ce-a7f4-c183fdc5b763" alt=""><figcaption><p>Figure 2. Assessment Report Button on Dataset Page</p></figcaption></figure>

## Resolve Failed Checks and Warnings

Failed and warning checks will impact Assessment Report scores. All checks will state any requirements and steps to address the issue. Use the provided instructions to revise your metadata.

Failed checks indicate that a **required field** does not follow the automated check criteria (Figure 3).&#x20;

<figure><img src="https://3166205607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgU7GrufgIOpY1Ufd5R%2Fuploads%2FXTLSPlLj4BMfahvwROcw%2FAssessmentReport_FailChecks_202510.png?alt=media&#x26;token=92715255-0a53-4900-bf41-837c6339c3be" alt=""><figcaption><p>Figure 3. Failed Automated Checks</p></figcaption></figure>

Warning checks indicate that an **optional field** does not follow the automated check criteria (Figure 4).&#x20;

<figure><img src="https://3166205607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgU7GrufgIOpY1Ufd5R%2Fuploads%2FysQGCDF5lXBsMEmAYiGw%2FAssessmentReport_WarningChecks_202510.png?alt=media&#x26;token=c17dec5d-9a0f-4569-ae45-62e5e950a78c" alt=""><figcaption><p>Figure 4. Warning Automated Checks</p></figcaption></figure>

After revising and resubmitting your dataset, check your score again to ensure you’ve addressed all issues. If you see any message other than the notice that the score is loading (Figure 5), please [contact ESS-DIVE support](https://ess-dive.lbl.gov/contact/).

<figure><img src="https://lh4.googleusercontent.com/5bn17R4TDyFvrGIu0Dv2eev-24mnyaThmb8FY3niSgLg3UPA7P_fERAoRUjUwyDQQSI1MqibAfR0V1xWgf_rK0p_9hMVKiIr63p6vTdS3XajG7MXz-42057sm9V20fukxleAhS7Zz-51UwyY6lbYujo" alt=""><figcaption><p>Figure 5. Assessment Report Loading Page</p></figcaption></figure>

## Automated Checks

The checks below are run on each dataset upon submission as a part of the ESS-DIVE automated check suite. Review the[ Dataset Requirements Page](https://docs.ess-dive.lbl.gov/contributing-data/package-level-metadata) for more detailed descriptions, formatting requirements, and examples for the automated checks.

Informational checks do not impact the Assessment Report score.

| Criteria                                                                                                         | Required/Optional | FAIR Category |
| ---------------------------------------------------------------------------------------------------------------- | ----------------- | ------------- |
| **Title** length between between 7 and 40 words                                                                  | Required          | Findable      |
| **Abstract** length is at least 100 words                                                                        | Required          | Findable      |
| **Publication date** is present                                                                                  | Required          | Findable      |
| **Creators**, at least one is present                                                                            | Required          | Findable      |
| **Dataset Contact**, ensure contact is present                                                                   | Required          | Accessible    |
| **Dataset Contact**, ensure ORCiD is provided                                                                    | Required          | Accessible    |
| **Start and End Dates** are present                                                                              | Required          | Findable      |
| **Project name** is from controlled list                                                                         | Optional          | Findable      |
| **Funding organization** "U.S. DOE > Office of Science > Biological and Environmental Research (BER)" is present | Optional          | Findable      |
| **Geographic Description** is present                                                                            | Optional          | Findable      |
| **Coordinates** describing the point location or geographic area of the dataset are present                      | Optional          | Findable      |
| **Methods** description is more than 7 words in length                                                           | Required          | Reusable      |
| **Data file formats** are non-proprietary                                                                        | Optional          | Reusable      |
| **Usage rights** is set to Creative Commons CC-BY license                                                        | Optional          | Reusable      |
| Informational: Number of contacts with email addresses provided                                                  | Informational     | Findable      |
| Informational: Number of creators with email addresses provided                                                  | Informational     | Findable      |
| Informational: Number of data entities present                                                                   | Informational     | Interoperable |

<p align="center"><em>Table 1: List of automated checks performed by the automated assessment suite</em></p>
