Home
Create
Activities
Overview
Benefits
Guiding principles
Architecture
Infrastructure
Metadata pipeline
Starter kit
Browse datasets
Search datasets
MATLAB API
Python API
Tutorials
REST-API
Visualization
BIDS data tools
dataset_description.json
BIDS-to-JSON (neuroj)
BIDS-to-JSON (MATLAB)
MATLAB/Octave users
jsonlab
jnifty
jsnirfy
zmat
easyh5
Python users
jdata
bjdata
JSON format
JData spec
BJData spec
JNIfTI spec
JSNIRF spec
JMesh spec
Login
Edit this page
View other revisions
Discuss
BIDS-compatible
dataset_description.json
editor
Copy JSON to clipboard
Running query ...
dataset_description
content
Update Form
Sharable link to this content
{ "Name": "", "License": "PDDL" }
Validation
This will update whenever the form changes to show validation errors if any.
Schema
{ "title": "dataset_description editor", "type": "object", "required": ["Name", "License"], "properties": { "Name": { "title": "Dataset name", "type": "string", "options": { "inputAttributes": { "placeholder": "Give your dataset a descriptive name" } } }, "BIDSVersion": { "title": "BIDS version (required for BIDS data)", "type": "string", "pattern": "\\d+\\.\\d+(\\.\\d+)*", "options": { "inputAttributes": { "placeholder": "1.9.0" } } }, "HEDVersion": { "title": "Hierarchical Event Descriptor (HED) version", "type": "string", "pattern": "\\d+\\.\\d+(\\.\\d+)*", "options": { "inputAttributes": { "placeholder": "8.2.0" } } }, "DatasetType": { "title": "Dataset type", "type": "string", "default": "raw", "enum": [ "raw", "derivative" ] }, "License": { "title": "Standard license", "type": "string", "default": "PDDL", "enum": [ "PDDL", "CC0", "PD", "CC-BY-4.0", "CC-BY-SA-4.0", "BSD-3-Clause", "BSD-2-Clause", "CDDL-1.0", "MPL", "MIT", "GPL-2.0", "GPL-2.0+", "GPL-3.0", "GPL-3.0+", "LGPL-3.0+", "GFDL-1.3", "CC-BY-NC-4.0", "CC-BY-NC-SA-4.0", "CC-BY-NC-ND-4.0", "Non-Standard" ], "options": { "enum_titles": [ "PDDL-1.0 - Open Data Commons Public Domain Dedication & License 1.0 (free/libre, maximally permissive)", "CC0-1.0 - Creative Commons Zero v1.0 Universal (public-domain, free/libre, maximally permissive)", "PD - Public domain (free/libre, maximally permissive)", "CC-BY-4.0 - Creative Commons Attribution 4.0 International (free/libre, permissive)", "CC-BY-SA-4.0 - Creative Commons Attribution Share Alike 4.0 International (free/libre, protective)", "BSD-3-Clause - BSD 3-Clause \"New\" or \"Revised\" License (free/libre, permissive)", "BSD-2-Clause - BSD 2-Clause \"Original\" or \"Old\" License (free/libre, permissive)", "CDDL-1.0 - Common Development and Distribution License 1.0 (free/libre, protective)", "MPL - Mozilla Public License 2.0 (free/libre, protective)", "MIT - MIT License (free/libre, permissive)", "GPL-2.0 - GNU General Public License v2.0 only (free/libre, protective)", "GPL-2.0+ - GNU General Public License v2.0 and later (free/libre, protective)", "GPL-3.0 - GNU General Public License v3.0 only (free/libre, protective)", "GPL-3.0+ - GNU General Public License v3.0 and later (free/libre, protective)", "LGPL-3.0+ - GNU Lesser General Public License v3.0 or later (free/libre, permissive)", "GFDL-1.3 - GNU Free Documentation License v1.3 (free/libre, permissive)", "CC-BY-NC-4.0 - Creative Commons Attribution Non Commercial 4.0 Generic (non-free)", "CC-BY-NC-SA-4.0 - Creative Commons Attribution Non Commercial Share Alike 4.0 International (non-free)", "CC-BY-NC-ND-4.0 - Creative Commons Attribution Non Commercial No Derivatives 4.0 International (non-free)", "Non-Standard - User-defined license (please use the DataLicense field to specify details, strongly not recommended)" ] } }, "DataLicense": { "title": "License details (if non-standard, not recommended)", "type": "string", "format": "textarea" }, "Authors": { "title": "Dataset authors", "type": "array", "items": { "type": "string", "anyOf": [ { "title": "Format: LastName, FirstName", "pattern": "[^,]+,\\s*[^,]+", "options": { "inputAttributes": { "placeholder": "LastName, FirstName" } } }, { "title": "Format: FirstName M. LastName", "pattern": "[^,]+(\\s+[A-Za-z]\\.*)*\\s+[^,]+", "options": { "inputAttributes": { "placeholder": "FirstName M. LastName" } } } ] }, "format": "table" }, "Acknowledgements": { "title": "Acknowledgements", "type": "string", "format": "textarea" }, "HowToAcknowledge": { "title": "How to acknowledge", "type": "string", "format": "textarea" }, "Funding": { "title": "Funding sources and grant numbers", "type": "array", "items": { "type": "string", "title": "Funding source" }, "format": "table" }, "EthicsApprovals": { "title": "IRB names and protocol numbers", "type": "array", "items": { "type": "string", "title": "IRB name and protocol number", "options": { "inputAttributes": { "placeholder": "IRB name: protocol number" } } }, "format": "table" }, "ReferencesAndLinks": { "title": "References and links to publications and websites", "type": "array", "items": { "type": "string", "title": "Reference or link", "format": "textarea" }, "format": "table" }, "DatasetDOI": { "title": "DOI full URL", "type": "string", "format": "uri", "pattern": "^(https?://doi.org/|doi:\\s*)*10.\\d{4,9}/[-._;()/:A-Za-z0-9]+$", "options": { "inputAttributes": { "placeholder": "https://doi.org/10.xxxx/yyyy-yyy-yyyy-y" } } }, "GeneratedBy": { "title": "Dataset creation software info", "type": "array", "items": { "type": "object", "title": "Software used", "required": [ "Name" ], "properties": { "Name": { "title": "Software name", "type": "string" }, "Version": { "title": "Software version", "type": "string" }, "CodeURL": { "title": "Software URL", "type": "string", "format": "uri" }, "Description": { "title": "Processing description", "type": "string", "format": "textarea" } } } }, "SourceDatasets": { "title": "Upstream source dataset info", "type": "array", "items": { "type": "object", "title": "Source data", "properties": { "DOI": { "title": "Upstream dataset DOI", "type": "string", "format": "uri", "pattern": "^(https?://doi.org/|doi:\\s*)*10.\\d{4,9}/[-._;()/:A-Za-z0-9]+$", "options": { "inputAttributes": { "placeholder": "https://doi.org/10.xxxx/yyyy-yyy-yyyy-y" } } }, "Version": { "title": "Software version", "type": "string" }, "URL": { "title": "Software URL", "type": "string", "format": "uri" } } } } } }