datapackage.json

Properties indicated with * are required.
Properties indicated with + can (and should) be derived/computed directly from the content of the datapacakge rather than provided manually.
The properties are listed by order of priority/importance with computed properties listed at the bottom as usually less relevant for users.

Datapackage

Source: geolocator-dp-profile.json

`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 and Datacite metadata schema.

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

Example:

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

`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.

Name	Definition	Type
`title`	Name of the contributor.	string
`givenName`	Given name of the contributor	string
`familyName`	Family name of the contributor	string
`path`	A fully qualified URL pointing to a relevant location online for the contributor	string
`email`	An email address.	string
`roles`	The type of contribution made by the person/organzation following a subset of DataCite Metadata Schema’s contributorType. We strongly suggest having `ContactPerson` and `ProjectLeader` to match Movebank requirements for a contact person and a principal investigator. Any contributors should be authors of the datapackage and appear in `bibliographicCitation`. `ContactPerson`: Person to whom to ask any questions related to the geolocator data pacakge such as how to access, use, cite, any additional information. `ProjectLeader`: Person officially designated as head of project (i.e., principal investigator). `DataCollector`: Person responsible for finding gathering/collecting the geolocator data. Typically used for ringers and field assistants. `DataCurator`: Person in charge of building the geolocator data package, including the gathering and standardizing the metadata and maintaining data and software code. Typically the person that used the `GeoLocatoR` package to build the data package. `Researcher`: A person involved in analyzing data or the results of the geolocator data. Typically used for the persons that run the GeoPressure analysis to produce the tracks. `RightsHolder`: Person or institution owning or managing property rights, including intellectual property rights over the resource. `Supervisor`: Designated administrator over the project. `Other`: Any person or institution making a significant contribution to the development and/or maintenance of the resource, but whose contribution does not fit other controlled vocabulary for contributorType. Constraints enum: `ContactPerson, ProjectLeader, DataCollector, DataCurator, Researcher, RightsHolder, Supervisor, Other`	array
`organization`	An organizational affiliation for this contributor.	string

Example:

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

`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"
}

`licenses`*

The license(s) under which the data is provided. name or path must be provided. If you’re not sure, check out the Creative Commons License Chooser and the Open Data Commons. Usually, a single license if sufficient and prefered. See Data Package specification.

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

Name	Definition	Type
`name`	Open Definition license identifier, see http://licenses.opendefinition.org/	string
`path`	A fully qualified URL.	string
`title`	A human-readable name of the license.	string

Example:

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

`id`

A globally unique identifier for the package, typically the concept DOI as full link. Note that you can reserve the first version DOI prior to publication. The corresponding concept DOI can be construct by substracting the ZENODO ID by 1 (https://doi.org/10.5281/zenodo.14620590 for a DOI reserved as 10.5281/zenodo.14620591) See Data Package specification.

Close to https://vocab.nerc.ac.uk/collection/MVB/current/MVB000172

Example:

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

`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 and Datacite metadata schema.

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

Example:

{
  "description": "This datapackage contains ..."
}

`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"
}

`relatedIdentifiers`

List of resources related to the package (e.g. papers, project pages, derived datasets, etc.). See Camtrap DP specification and Datacite metadata schema.

Name	Definition	Type
`relationType` *	Description of the relationship between the the package and the related resource. To help you choose the type, think of ‘This package {relationType} the related resource’. Learn more about these relationships. Constraints enum: IsCitedBy, Cites, IsSupplementTo, IsSupplementedBy, IsContinuedBy, Continues, IsNewVersionOf, IsPreviousVersionOf, IsPartOf, HasPart, IsPublishedIn, IsReferencedBy, References, IsDocumentedBy, Documents, IsCompiledBy, Compiles, IsVariantFormOf, IsOriginalFormOf, IsIdenticalTo, HasMetadata, IsMetadataFor, Reviews, IsReviewedBy, IsDerivedFrom, IsSourceOf, Describes, IsDescribedBy, HasVersion, IsVersionOf, Requires, IsRequiredBy, Obsoletes, IsObsoletedBy, Collects, IsCollectedBy, HasTranslation, IsTranslationOf Same as https://schema.datacite.org/meta/kernel-4.6/include/datacite-relationType-v4.xsd	string
`relatedIdentifier` *	Unique identifier of the related resource (e.g. the DOI or URL of the related resource).	string
`relatedIdentifierType` *	Type of the `relatedIdentifier`. Learn more about these types. Constraints enum: `DOI, URL, ARK, arXiv, bibcode, CSTR, EAN13, EISSN, Handle, IGSN, ISBN, ISSN, ISTC, LISSN, LSID, PMID, PURL, RRID, UPC, URN, w3id` Same as https://schema.datacite.org/meta/kernel-4.6/include/datacite-relatedIdentifierType-v4.xsd	string
`resourceTypeGeneral`	General type of the related resource. Learn more about these type of resources. Constraints enum: `Audiovisual, Book, BookChapter, Collection, ComputationalNotebook, ConferencePaper, ConferenceProceeding, DataPaper, Dataset, Dissertation, Event, Image, InteractiveResource, Journal, JournalArticle, Model, OutputManagementPlan, PeerReview, PhysicalObject, Preprint, Report, Service, Software, Sound, Standard, Text, Workflow, Other` Same as https://schema.datacite.org/meta/kernel-4.4/include/datacite-resourceType-v4.xsd	string

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"
    }
  ]
}

`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"]
}

`keywords`

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

Example:

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

`created`*^,+

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

Example:

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

`temporal`*^,+

Temporal coverage of the package. Computed based on observations.datetime. Different in format, but equivalent in idea to GBIF metadata profile.

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

Name	Definition	Type
`start` *	Start date of the first observation. Formatted as an ISO 8601 string (`YYYY-MM-DD`).	string
`end` *	End date of the last observation. Formatted as an ISO 8601 string (`YYYY-MM-DD`).	string

Example:

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

`spatial`*^,+

Spatial coverage of the package, expressed as GeoJSON. Generally computed as the bounding box of observations, paths and pressurepath. Different in format, but equivalent in idea to GBIF metadata profile.

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

Example:

{
  "spatial": {
    "geometry": {
      "type": "Polygon",
      "coordinates": [[[30.0, -10.0], [35.0, -10.0], [35.0, -5.0], [30.0, -5.0], [30.0, -10.0]]]
    }
  }
}

`taxonomic`*^,+

Taxonomic coverage of the package. List of all scientific names of all animals equipped. Computed based on the unique tag.scientific_name. Different in format, but equivalent in idea to GBIF metadata profile.

Example:

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

`numberTags`*^,+

A list of the number of tags from various category.

Name	Definition	Type
`tags`	Number of tags in `tags.csv`, thus usually the number of tags produced for the project and equipped on birds.	number
`measurements`	Number of tags in `measurements.csv`, thus the number of tags for which some data were retrieved.	number
`light`	Number of tags in `measurements.csv` with some light data.	number
`pressure`	Number of tags in `measurements.csv` with some pressure data.	number
`activity`	Number of tags in `measurements.csv` with some activity or pitch data.	number
`temperature_external`	Number of tags in `measurements.csv` with some external temperature data.	number
`temperature_internal`	Number of tags in `measurements.csv` with some internal temperature data.	number
`magnetic`	Number of tags in `measurements.csv` with some magnetic data.	number
`wet_count`	Number of tags in `measurements.csv` with some wet_count data.	number
`conductivity`	Number of tags in `measurements.csv` with some conductivity data.	number
`paths`	Number of tags in `paths.csv`.	number
`pressurepaths`	Number of tags in `pressurepaths.csv`.	number

`bibliographicCitation`⁺

Bibliographic/recommended citation for the package. Ideally, same author as contributors, same date as created, same title as title and same doi as id.

Same as http://purl.org/dc/terms/bibliographicCitation, https://vocab.nerc.ac.uk/collection/MVB/current/MVB000068

Example:

{
  "bibliographicCitation": "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"
}

`referenceLocation`⁺

Reference location for the study is used to display the study on a map. Choose a central position for your study, typically the main deployment site. This is required to upload your data on Movebank.

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

Name	Definition	Type
`latitude` *	Reference latitude in degree decimal. Same as http://vocab.nerc.ac.uk/collection/MVB/current/MVB000222	number
`longitude` *	Reference longitude in degree decimal. Same as http://vocab.nerc.ac.uk/collection/MVB/current/MVB000223	number

Example:

{
  "referenceLocation": {
    "latitude": -13.02,
    "longitude": 151.07,
  }
}

`$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/refs/tags/v0.2/geolocator-dp-profile.json"
}

`resources`*

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

Name	Definition	Type
`name` *	Identifier of the resource. See Data Package specification. Constraints enum: `tags, observations, measurements, staps, twilights, paths, edges, pressurepaths`
`type`	Type of the resource. Only `table` are allowed. See Data Package specification. Constraints enum: `table`
`path` *	Path or URL to the data file. See Data Package specification.
`$schema` *	URL of the used GeoLocator DP Table Schema version. See Data Package specification.

On this page

Datapackage

title*

contributors*

embargo*

licenses*

id

description

version

relatedIdentifiers

grants

keywords

created*,+

temporal*,+

spatial*,+

taxonomic*,+

numberTags*,+

bibliographicCitation+

referenceLocation+

$schema*

resources*

`title`*

`contributors`*

`embargo`*

`licenses`*

`id`

`description`

`version`

`relatedIdentifiers`

`grants`

`keywords`

`created`*^,+

`temporal`*^,+

`spatial`*^,+

`taxonomic`*^,+

`numberTags`*^,+

`bibliographicCitation`⁺

`referenceLocation`⁺

`$schema`*

`resources`*