The National Sleep Research Resource adheres to many processes and
procedures that closely align with the
FAIR Guiding Principles.
F1. (meta)data are assigned a globally unique and eternally persistent identifier.
Datasets and associated documentation/files use a consistent URL structure. Each dataset has a Digital Object Identifier (DOI) pointing to its landing page.
F2. data are described with rich metadata.
- Physiological data include documentation such as device manuals, montages, sampling rate information, and scoring manuals.
Spout data dictionaries describe covariate data in version-controlled git repositories.
F3. (meta)data are registered or indexed in a searchable resource.
Dataset documentation and metadata are searchable through the NSRR
F4. metadata specify the data identifier.
- Spout data dictionaries include an "identifier" variable type for this purpose.
A1. (meta)data are retrievable by their identifier using a standardized communications protocol.
- NSRR data and metadata are retrievable through HTTPS and via a versioned JSON API for programmatic access.
A1.1 the protocol is open, free, and universally implementable.
- HTTPS meets these standards and is universally used. The JSON API can be accessed by any modern programming language that includes a JSON library.
A1.2 the protocol allows for an authentication and authorization procedure, where necessary.
- Access to NSRR data is controlled per user. Most datasets require a data request to be reviewed and approved by the NSRR Internal Review Committee before data access is granted. The JSON API lists and grants access by authenticating users based on their approved (time limited) data access requests.
A2. metadata are accessible, even when the data are no longer available.
- Metadata are accessible on NSRR and on GitHub in data dictionary repositories.
I1. (meta)data use a formal, accessible, shared, and broadly applicable language for knowledge representation.
- Spout provides a structured approach to storing metadata in data dictionaries.
I2. (meta)data use vocabularies that follow FAIR principles.
- The vocabularies used to describe NSRR data and metadata are readily findable and accessible, and open source formats are used wherever possible (interoperable and re-usable).
I3. (meta)data include qualified references to other (meta)data.
- All facets of an NSRR dataset (data, metadata, and other documentation) are closely linked and interconnected wherever possible.
R1. (meta)data have a plurality of accurate and relevant attributes.
- Data and metadata are reviewed by the NSRR team for accuracy, correctness, and comprehensibility before public release.
R1.1. (meta)data are released with a clear and accessible data usage license.
- Rules and regulations about data use are described in the legal agreements that accompany data requests.
R1.2. (meta)data are associated with their provenance.
- Data and associated documentation are closely linked on the site.
- Variables in spout data dictionaries are linked to data collect instruments.
R1.3. (meta)data meet domain-relevant community standards.
- Data use open file formats (e.g. EDF, CSV) to maximize compatibility and reusability.
- Spout data dictionaries store metadata in JSON format.
* (meta)data refers to both metadata and data.