mne_bids.make_dataset_description#
- mne_bids.make_dataset_description(*, path, name, hed_version=None, dataset_type='raw', data_license=None, authors=None, acknowledgements=None, how_to_acknowledge=None, funding=None, ethics_approvals=None, references_and_links=None, doi=None, generated_by=None, source_datasets=None, overwrite=False, verbose=None)[source]#
Create a dataset_description.json file for a BIDS dataset.
The dataset_description.json file is required in BIDS and describes several general aspects of the dataset. You can use this function to freely add metadata fields to this file. See the BIDS specification for information about what each metadata field means.
- Parameters:
- path
str
A path to a folder where the description will be created.
- name
str
The name of this BIDS dataset.
- hed_version
str
If HED tags are used: The version of the HED schema used to validate HED tags for study.
- dataset_type
str
Must be either “raw” or “derivative”. Defaults to “raw”.
- data_license
str
|None
The license under which this dataset is published.
- authors
list
|str
|None
List of individuals who contributed to the creation/curation of the dataset. Must be a list of str (e.g., [‘a’, ‘b’, ‘c’]) or a single comma-separated str (e.g., ‘a, b, c’).
- acknowledgements
str
|None
A str acknowledging individuals who contributed to the creation/curation of this dataset.
- how_to_acknowledge
str
|None
A str describing how to acknowledge this dataset.
- funding
list
|str
|None
List of sources of funding (e.g., grant numbers). Must be a list of str (e.g., [‘a’, ‘b’, ‘c’]) or a single comma-separated str (e.g., ‘a, b, c’).
- ethics_approvals
list
|str
|None
List of ethics committee approvals of the research protocols and/or protocol identifiers. Must be a list of str (e.g., [‘a’, ‘b’, ‘c’]) or a single comma-separated str (e.g., ‘a, b, c’).
- references_and_links
list
|str
|None
List of references to publication that contain information on the dataset, or links. Must be a list of str (e.g., [‘a’, ‘b’, ‘c’]) or a single comma-separated str (e.g., ‘a, b, c’).
- doi
str
|None
The Digital Object Identifier of the dataset (not the corresponding paper). Must be of the form
doi:<insert_doi>
(e.g., doi:10.5281/zenodo.3686061).- generated_by
list
ofdict
|None
Used to specify provenance of the dataset. See BIDS specification for details.
- source_datasets
list
ofdict
|None
Used to specify the locations and relevant attributes of all source datasets. Each dict in the list represents one source dataset and may contain the following keys:
URL
,DOI
,Version
.- overwrite
bool
Whether to overwrite existing files or data in files. Defaults to False. If overwrite is True, provided fields will overwrite previous data. If overwrite is False, no existing data will be overwritten or replaced.
- verbose
bool
|str
|int
|None
Control verbosity of the logging output. If
None
, use the default verbosity level. See the logging documentation andmne.verbose()
for details. Should only be passed as a keyword argument.
- path
Notes
The required metadata field
BIDSVersion
will be automatically filled in by mne_bids.
Examples using mne_bids.make_dataset_description
#
02. Convert MNE sample data to BIDS format