Miscellaneous¶

dataset¶

class dataset

a class to represent the metadata for this project dataset as a whole, including a license information based on a license object.

a typical dataset would look something like below:

example dataset object¶

{
    "name":        "HumanForagingBehavior_PostdocRoom",
    "description": "Tracking data of human subjects performing a foraging task inside a post-doc room",
    "keywords":    ["foraging behavior", "human", "scientists"],
    "license":     {
        "name":    "CC0",
        "uri":     "http://creativecommons.org/publicdomain/zero/1.0",
        "year":    "2019",
        "authors": { "$ref": "/people" }
    },
    "references": [
        {
            "reference_type": "is-supplement-to",
            "name": "Sehara K, Colomb J, Larkum ME (2019) Dendritic mechanisms underlying foraging behavior of human subjects.",
            "uri": "doi:10.1101/000000"
        }
    ]
}

name¶: a required string property representing the identifiable name of this dataset as a whole.

description¶: a required string property representing the description of this dataset as a whole.

keywords¶: an optional array of string objects representing the free keywords for this dataset.

license¶: a required license object corresponding to the license clause of this dataset publication.

references¶: a required array of citation objects referring to the articles related to this dataset.

credit¶

class credit

a string role of a contributor, specified in terms of contributor roles (as it is defined in the CRediT taxonomy).

It must be one of the followings:

conceptualization
project-administration
supervision
funding-acquisition
investigation
methodology
software
formal-analysis
visualization
writing-original-draft
writing-review-editing
data-curation

funding¶

class funding

funding represents a funding source from an individual.

source¶: a required property referencing an individual, indicating the funding body.

provided_to¶: a required array of person instances indicating to whom the funding is supposed to be given.

id¶: a required string property that identifies the funding from the source.