datapackage.json

The metadata is critical for describing your dataset and making your record findable. The metadata associated with a GeoLocator DP are expressed in the datapackage.json file. It follows the Data Package specifications together with Movebank Study Attributes. Properties indicated with * are required (i.e. cannot be empty).

We only require minimal metadata to be able to upload the data on Zenodo, create a study page on Movebank or Upload on GBIF, but we strongly encourage entering as many of the fields as possible.

Datapackage

Source: geolocator-dp-profile.json

$schema*

See Data Package specification. GeoLocator DP further requires this to be the URL of the used GeoLocator DP Profile version.

Example:

{
  "name": "https://raw.githubusercontent.com/rafnuss/geolocator-dp/1.0/geolocator-dp-profile.json"
} 

name

A simple name or human-readable identifier (any lowercase alphanumeric characters plus ., - and _). See Data Package specification.

Example:

{
  "name": "mangrove-kingfisher-in-kenya"
} 

id

A globally unique identifier for the package, such as a UUID or DOI. See Data Package specification.

Example:

{
  "id": "http://dx.doi.org/10.5281/zenodo.11207081"
} 

licenses*

The license(s) under which the data is provided. name or path must be provided. See Data Package specification.

Broader than https://vocab.nerc.ac.uk/collection/MVB/current/MVB000257

Example:

{
  "licenses": [
    {
      "name": "CC-BY-4.0",
      "path": "https://creativecommons.org/licenses/by/4.0/",
      "title": "Creative Commons Attribution 4.0"
    }
  ]
} 

title*

A string providing a title or one sentence description for this package. It should be plain text (no markup), capitalised like a title, NOT end in a period and less than 65 characters. See Data Package specification.

Same as https://vocab.nerc.ac.uk/collection/MVB/current/MVB000172

Example:

{
  "title": "Woodland Kingfisher Geolocator data"
} 

description

A markdown-formatted string describing the package. You can (and should!) use multiple sentences, but limited to a single paragraph. See Data Package specification.

Same as https://vocab.nerc.ac.uk/collection/MVB/current/MVB000176

Example:

{
  "description": "# This datapackage contains the geolocator data collected on 8 Woodland Kingfishers equipped in South Africa."
} 

homepage

A URL for the home on the web related to this data package. See Data Package specification.

Example:

{
  "homepage": "https://github.com/Rafnuss/WoodlandKingfisher"
} 

image

An image to use for this data package. See Data Package specification.

Example:

{
  "image": "https://raw.githubusercontent.com/Rafnuss/WoodlandKingfisher/main/output/NDVI_animation/077531d34e04506aeb5e3d3066a8e06e-19ff78ccc543bbb66a89d90b1ae3fd17_getPixels.gif"
} 

version

A string identifying the version of the package, ideally following Semantic Versioning. See the Data Package specification and Data Package Version recipe.

Example:

{
  "version": "0.0.1"
} 

created*

The datetime on which the package was created. See Data Package specification.

Example:

{
  "created": "2024-05-17"
} 

embargo*

End date of the embargo. The repository will restrict access to the data until the end of the embargo period; at which time, the content will become publically available automatically. If no embargo is provided, it is assumed that there is no embargo.

Example:

{
  "embargo": "2024-05-17"
} 

keywords

A list of keywords to help users find the package. See Data Package specification.

Example:

{
  "keywords": [
    "intra-african",
    "NDVI",
    "geopressure"
  ]
} 

contributors*

A list of contributors, where each contributor is a list with properties including at least title but also optionally givenName, familyName, path, email, roles, and organization. See Data Package specification.

Example:

{
  "contributors": [
    {
      "title": "Yann Rime",
      "email": "yann.rime@vogelwarte.ch",
      "roles": ["Researcher"]
    },
    {
      "title": "Raphaël Nussbaumer",
      "email": "raphael.nussbaumer@vogelwarte.ch",
      "roles": ["ContactPerson", "ProjectLeader"]
    }
  ]
} 

citation

Bibliographic/recommended citation for the package.

Same as https://vocab.nerc.ac.uk/collection/MVB/current/MVB000068

Example:

{
  "citation": "Nussbaumer, R., & Rime, Y. (2024). Woodland Kingfisher: Migration route and timing of South African Woodland Kingfisher (v1.1). Zenodo. https://doi.org/10.5281/zenodo.11207141"
} 

grants

A list of grants and other funding sources of the project.

Same as https://vocab.nerc.ac.uk/collection/MVB/current/MVB000123/

Example:

{
  "grants": ["Hilfsfonds für die Schweizerische Vogelwarte Sempach"]
} 

reference_location*

Reference location for the study is used to display the study on a map. Choose a central area for your study, typically the main deployment site. This is mostly used for Movebank

Example:

{
  "reference_location": {
    "latitude": -13.02,
    "longitude": 151.07,
    "description": "Forest area with nest boxes"
  }
} 

temporal*

Temporal coverage of the package. Computed based on observations.datetime. See GBIF metadata profile

Same as https://purl.org/dc/terms/temporal

Example:

{
  "temporal": {
    "start": "2017-01-10",
    "end": "2019-09-29"
  }
} 

taxonomic*

Taxonomic coverage of the package. List of all scientific names of all animals equipped. Computed based on the unique tag.scientific_name. See GBIF metadata profile

Example:

{
  "taxonomic": ["Halcyon senegaloides"]
} 

relatedIdentifiers

Identifiers of resources related to the package (e.g. papers, project pages, derived datasets, APIs, etc.). See Camtrap DP specification.

Example:

{
  "relatedIdentifiers": [
    {
      "relationType": "IsSupplementTo",
      "relatedIdentifier": "10.1111/jav.02860",
      "relatedIdentifierType": "DOI"
    },
    {
      "relationType": "IsDescribedBy",
      "relatedIdentifier": "http://dx.doi.org/10.13140/RG.2.2.34477.10721",
      "relatedIdentifierType": "URL"
    }
  ]
} 

references

List of references related to the package (e.g. references cited in package.description). References preferably include a DOI. See Camtrap DP specification.

resources*

See Data Package specification. GeoLocator DP further requires each object to be a Tabular Data Resource with a specific name and $schema.