Skip to content

data-sheets-schema

A LinkML schema for Datasheets for Datasets.

URI: https://w3id.org/bridge2ai/data-sheets-schema

Name: data-sheets-schema

Classes

Class Description
FormatDialect Additional format information for a file
Information Grouping for datasets and data files
        Dataset A single component of related observations and/or information that can be read, manipulated, transformed, and otherwise interpreted.
                DataSubset A subset of a dataset, likely containing multiple files of multiple potential purposes and properties.
        DatasetCollection A collection of related datasets, likely containing multiple files of multiple potential purposes and properties.
NamedThing A generic grouping for any identifiable entity
        AnatomicalEntity A subcellular location, cell type or gross anatomical part
        DatasetProperty Represents a single property of a dataset, or a set of related properties.
                AddressingGap Was there a specific gap that needed to be filled by creation of the dataset?
                CleaningStrategy Was any cleaning of the data done (e.g., removal of instances, processing of missing values)?
                CollectionConsent Did the individuals in question consent to the collection and use of their data? If so, please describe (or show with screenshots or other information) how consent was requested and provided, and provide a link or other access point to, or otherwise reproduce, the exact language to which the individuals consented.
                CollectionMechanism What mechanisms or procedures were used to collect the data (e.g., hardware apparatuses or sensors, manual human curation, software programs, software APIs)? How were these mechanisms or procedures validated?
                CollectionNotification Were the individuals in question notified about the data collection? If so, please describe (or show with screenshots or other information) how notice was provided, and provide a link or other access point to, or otherwise reproduce, the exact language of the notification itself.
                CollectionTimeframe Over what timeframe was the data collected? Does this timeframe match the creation timeframe of the data associated with the instances (e.g., recent crawl of old news articles)? If not, please describe the timeframe in which the data associated with the instances was created.
                Confidentiality Does the dataset contain data that might be considered confidential (e.g., data that is protected by legal privilege or by doctor patient confidentiality, data that includes the content of individuals’ non-public communications)?
                ConsentRevocation If consent was obtained, were the consenting individuals provided with a mechanism to revoke their consent in the future or 8 for certain uses? If so, please provide a description, as well as a link or other access point to the mechanism (if appropriate).
                ContentWarning Does the dataset contain data that, if viewed directly, might be offensive, insulting, threatening, or might otherwise cause anxiety? If so, please describe why.
                Creator Who created the dataset (e.g., which team, research group) and on behalf of which entity (e.g., company, institution, organization)? This may also be considered a team.
                DataAnomaly Are there any errors, sources of noise, or redundancies in the dataset? If so, please provide a description.
                DataCollector Who was involved in the data collection process (e.g., students, crowdworkers, contractors) and how were they compensated (e.g., how much were crowdworkers paid)?
                DataProtectionImpact Has an analysis of the potential impact of the dataset and its use on data subjects (e.g., a data protection impact analysis) been conducted? If so, please provide a description of this analysis, including the outcomes, as well as a link or other access point to any supporting documentation.
                Deidentification Is it possible to identify individuals (i.e., one or more natural persons), either directly or indirectly (i.e., in combination with other data) from the dataset?
                DirectCollection Did you collect the data from the individuals in question directly, or obtain it via third parties or other sources (e.g., websites)?
                DiscouragedUse Are there tasks for which the dataset should not be used?
                DistributionDate When will the dataset be distributed?
                DistributionFormat How will the dataset will be distributed (e.g., tarball on website, API, GitHub)?
                Erratum Is there an erratum? If so, please provide a link or other access point.
                EthicalReview Were any ethical review processes conducted (e.g., by an institutional review board)? If so, please provide a description of these review processes, including the outcomes, as well as a link or other access point to any supporting documentation.
                ExistingUse Has the dataset been used for any tasks already?
                ExportControlRegulatoryRestrictions Do any export controls or other regulatory restrictions apply to the dataset or to individual instances? If so, please describe these restrictions, and provide a link or other access point to, or otherwise reproduce, any supporting documentation.
                ExtensionMechanism If others want to extend/augment/build on/contribute to the dataset, is there a mechanism for them to do so? If so, please provide a description. Will these contributions be validated/verified? If so, please describe how. If not, why not? Is there a process for communicating/distributing these contributions to dataset consumers? If so, please provide a description.
                ExternalResource Is the dataset self-contained, or does it link to or otherwise rely on external resources (e.g., websites, tweets, other datasets)? If it links to or relies on external resources, a) are there guarantees that they will exist, and remain constant, over time; b) are there official archival versions of the complete dataset (i.e., including the external resources as they existed at the time the dataset was created); c) are there any restrictions (e.g., licenses, fees) associated with any of the external resources that might apply to a dataset consumer? Please provide descriptions of all external resources and any restrictions associated with them, as well as links or other access points, as appropriate.
                FundingMechanism Who funded the creation of the dataset? If there is an associated grant, please provide the name of the grantor and the grant name and number.
                FutureUseImpact Is there anything about the composition of the dataset or the way it was collected and preprocessed/cleaned/labeled that might impact future uses? For example, is there anything that a dataset consumer might need to know to avoid uses that could result in unfair treatment of individuals or groups (e.g., stereotyping, quality of service issues) or other risks or harms (e.g., legal risks, financial harms)? If so, please provide a description. Is there anything a dataset consumer could do to mitigate these risks or harms?
                Instance What do the instances that comprise the dataset represent (e.g., documents, photos, people, countries)?
                InstanceAcquisition How was the data associated with each instance acquired? Was the data directly observable (e.g., raw text, movie ratings), reported by subjects (e.g., survey responses), or indirectly inferred/derived from other data (e.g., part-of-speech tags, model-based guesses for age or language)? If the data was reported by subjects or indirectly inferred/derived from other data, was the data validated/verified?
                IPRestrictions Have any third parties imposed IP-based or other restrictions on the data associated with the instances? If so, please describe these restrictions, and provide a link or other access point to, or otherwise reproduce, any relevant licensing terms, as well as any fees associated with these restrictions.
                LabelingStrategy Was any preprocessing/cleaning/labeling of the data done (e.g., part-of-speech tagging)?
                LicenseAndUseTerms Will the dataset be distributed under a copyright or other intellectual property (IP) license, and/or under applicable terms of use (ToU)? If so, please describe this license and/or ToU, and provide a link or other access point to, or otherwise reproduce, any relevant licensing terms or ToU, as well as any fees associated with these restrictions.
                Maintainer Who will be supporting/hosting/maintaining the dataset?
                MissingInfo Is any information missing from individual instances? If so, please provide a description, explaining why this information is missing (e.g., because it was unavailable). This does not include intentionally removed information, but might include, e.g., redacted text.
                OtherTask What (other) tasks could the dataset be used for?
                PreprocessingStrategy Was any preprocessing of the data done (e.g., discretization or bucketing, tokenization, SIFT feature extraction)?
                Purpose For what purpose was the dataset created?
                RawData Was the “raw” data saved in addition to the preprocessed/cleaned/labeled data (e.g., to support unanticipated future uses)? If so, please provide a link or other access point to the “raw” data.
                Relationships Are relationships between individual instances made explicit (e.g., users’ movie ratings, social network links)? If so, please describe how these relationships are made explicit.
                RetentionLimits If the dataset relates to people, are there applicable limits on the retention of the data associated with the instances (e.g., were the individuals in question told that their data would be retained for a fixed period of time and then deleted)? If so, please describe these limits and explain how they will be enforced.
                SamplingStrategy Does the dataset contain all possible instances or is it a sample (not necessarily random) of instances from a larger set? If the dataset is a sample, then what is the larger set? Is the sample representative of the larger set (e.g., geographic coverage)? If so, please describe how this representativeness was validated/verified. If it is not representative of the larger set, please describe why not (e.g., to cover a more diverse range of instances, because instances were withheld or unavailable).
                SensitiveElement Does the dataset contain data that might be considered sensitive in any way (e.g., data that reveals race or ethnic origins, sexual orientations, religious beliefs, political opinions or union memberships, or locations; financial or health data; biometric or genetic data; forms of government identification, such as social security numbers; criminal history)?
                Splits Are there recommended data splits (e.g., training, development/validation, testing)? If so, please provide a description of these splits, explaining the rationale behind them.
                Subpopulation Does the dataset identify any subpopulations (e.g., by age, gender)? If so, please describe how these subpopulations are identified and provide a description of their respective distributions within the dataset.
                Task Was there a specific task in mind for the dataset's application?
                ThirdPartySharing Will the dataset be distributed to third parties outside of the entity (e.g., company, institution, organization) on behalf of which the dataset was created?
                UpdatePlan Will the dataset be updated (e.g., to correct labeling errors, add new instances, delete instances)? If so, please describe how often, by whom, and how updates will be communicated to dataset consumers (e.g., mailing list, GitHub)?
                UseRepository Is there a repository that links to any or all papers or systems that use the dataset? If so, please provide a link or other access point.
                VersionAccess Will older versions of the dataset continue to be supported/hosted/maintained? If so, please describe how. If not, please describe how its obsolescence will be communicated to dataset consumers.
        Grant What is the name and/or identifier of the specific mechanism providing monetary support or other resources supporting creation of the dataset?
        Organization Represents a group or organization related to or responsible for one or more Bridge2AI standards.
                Grantor What is the name and/or identifier of the organization providing monetary support or other resources supporting creation of the dataset?
        Person An individual human being.
        Software A software program or library.
OrganizationContainer A container for Organizations.

Slots

Slot Description
acquisition_methods
addressing_gaps
affiliation The organization(s) to which the person belongs
anomalies
archival
bytes Size of the data in bytes
category Name of the high level ontology class in which this entity is categorized
cleaning_strategies
collection_mechanisms
collection_timeframes
comment_prefix
compression The compression format of the data
confidential_elements
confidential_elements_present
conforms_to The standard to which the data conforms
conforms_to_class The class in the schema to which the data object instantiates
conforms_to_schema The schema to which the data conforms
content_warnings
content_warnings_present
contribution_date The date on which the node was added
contributor_github_name The name of the github user who added this node
contributor_name The name of the person who added this node
contributor_orcid The ORCiD of the person who added this node
counts How many instances are there in total (of each type, if appropriate)?
created_by Agent that created the element
created_on Date and Time at which the element was created
creators
data_collectors
data_protection_impacts
data_substrate What data does each instance consist of? “Raw” data (e
data_topic What general topic does the data represent? This should be one of the Bridge2...
delimiter
description A human-readable description for a thing
dialect
discouraged_uses
distribution
distribution_dates
distribution_formats
doi The Digital Object Identifier of the data, with the doi prefix
double_quote
download_url URL from which the data can be downloaded
edam_id Unique EDAM identifier
email The email address of the person
encoding The encoding of the data
errata
ethical_reviews
existing_uses
extension_mechanism
external_resources
format The format of the data
funders
future_guarantees
future_use_impacts
grant
grant_number The alphanumeric identifier for the grant
grantor
hash The hash representation of the data, e
header
id A unique identifier for a thing
identifiable_elements_present
identification
instance_type Are there multiple types of instances (e
instances
ip_restrictions
is_data_split Is this subset a split of the larger dataset, e
is_deidentified
is_random
is_representative
is_sample
is_subpopulation Is this subset a subpopulation of the larger dataset, e
is_tabular
issued
keywords Keywords associated with the data
label Is there a label or target associated with each instance?
label_description If there is a label or target associated with each instance, what pattern or ...
labeling_strategies
language language in which the information is expressed
last_updated_on Date and Time at which the element was last updated
license license for the data
license_and_use_terms
maintainers
md5 The md5 hash representation of the data
media_type The media type of the data
mesh_id Unique MeSH identifier
missing
missing_information
modified_by agent that modified the element
name A human-readable name for a thing
ncit_id Unique NCIt Identifier
node_property A grouping for any property that holds between a node and a value
organizations Collection of associated organizations
other_tasks
page
path
preprocessing_strategies
principal_investigator
profile The frictionless data profile to which the data conforms
publisher
purposes
quote_char
raw_sources
regulatory_restrictions
related_to A relationship that is asserted between two named things
representative_verification
resources
response
restrictions
retention_limit
ror_id Unique ROR identifier
sampling_strategies
sensitive_elements
sensitive_elements_present
sha256 The sha256 hash representation of the data
source_data
status Status of the element in terms of its maturity or life cycle
strategies If the dataset is a sample from a larger set, what was the sampling strategy ...
subclass_of Holds between two classes where the domain class is a specialization of the r...
subpopulation_elements_present
subpopulations
subsets
tasks
themes Themes associated with the data
title the official title of the element
type A generic slot for any label corresponding to the label for an entity type a...
updates
url URL for basic documentation of the standard or tool
use_repository
used_software What software was used as part of this dataset property?
version particular version of schema
version_access
warnings
was_derived_from A derivation is a transformation of an entity into another, an update of an e...
was_directly_observed Was the data directly observable (e
was_inferred_derived Was the data indirectly inferred/derived from other data (e
was_reported_by_subjects Was the data reported by subjects (e
was_validated_verified Was the data validated/verified?
why_missing
why_not_representative
wikidata_id Unique Wikidata identifier
xref URI of corresponding class in an ontology of experimental procedures, in CURI...

Enumerations

Enumeration Description
CompressionEnum
CreatorOrMaintainerEnum The entity responsible for maintaining a dataset
DataGeneratingProject One of the Bridge2AI Data Generating Projects
EncodingEnum
FormatEnum
MediaTypeEnum

Types

Type Description
Boolean A binary (true or false) value
CategoryType A primitive type in which the value denotes a class within the model
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
EdamIdentifier Identifier from EDAM ontology
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
MeshIdentifier Identifier from Medical Subject Headings (MeSH) biomedical vocabulary
NcitIdentifier Identifier from NCIT reference terminology with broad coverage of the cancer ...
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
RorIdentifier Identifier from Research Organization Registry
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE
WikidataIdentifier Identifier from Wikidata open knowledge base

Subsets

Subset Description
Collection The questions in this section are designed to elicit information that may hel...
Composition The questions in this section are intended to provide dataset consumers with ...
Distribution The questions in this section pertain to dataset distribution
Maintenance The questions in this section are intended to encourage dataset creators to p...
Motivation The questions in this section are primarily intended to encourage dataset cre...
Preprocessing-Cleaning-Labeling The questions in this section are intended to provide dataset consumers with ...
Uses The questions in this section are intended to encourage dataset creators to r...