IQSS / IQSS/dataverse

Feature Request: add bounding boxes to all metadata formats based on schema.org

Open
#11,582 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
Schema.org and derived metadata formats have ways of describing geographic extents that allow indexers (Google dataset search, DataONE, etc.) to limit searches based on location. These are not currently included in Dataverse's serializations of metadata to schema.org formats.

What kind of user is the feature intended for?
Metadata consumer (Google, DataONE, other dataset search indexes)

What inspired the request?
I noticed that while Dataverse schema.org metadata is otherwise very descriptive, it does not include a "geo" node in the "spatialCoverage" definition, which means that datasets ingested by indexers are not typically searchable by location.

What existing behavior do you want changed?
n/a

Any brand new behavior do you want to add to Dataverse?
When records contain quantitative spatial information, it should be serialized to schema.org and its derived formats OAI_ORE and croissant.
There are examples for how to describe bounding boxes in schema.org vocabulary in the science-on-schema.org Dataset guide. Generally, bounding boxes will be described as follows:

{
  ...
  "spatialCoverage": {
    "@type": "Place",
    "geo": {
      "@type": "GeoShape",
      "box": "{SOUTH} {WEST} {NORTH} {EAST}"
    }
  }
}

Any open or closed issues related to this feature request?

  • #11580

Are you thinking about creating a pull request for this feature?
Perhaps, if time allows

Related discussion

https://dataverse.zulipchat.com/#narrow/channel/378866-troubleshooting/topic/DataONE.20search/near/523282972

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the serializers for schema.org, OAI_ORE, and croissant, then compare how quantitative spatial metadata is currently represented. Read the linked schema.org bounding-box guidance and verify that records with spatial extents emit the requested GeoShape data in all three formats.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.