mne_bids.make_dataset_description¶
- mne_bids.make_dataset_description(path, name, data_license=None, authors=None, acknowledgements=None, how_to_acknowledge=None, funding=None, references_and_links=None, doi=None, dataset_type='raw', overwrite=False, verbose=None)[source]¶
Create json for a dataset description.
BIDS datasets may have one or more fields, this function allows you to specify which you wish to include in the description. See the BIDS documentation for information about what each field means.
- Parameters
- path
str
A path to a folder where the description will be created.
- name
str
The name of this BIDS dataset.
- 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 or a single comma separated str like [‘a’, ‘b’, ‘c’].
- acknowledgements
list
|str
|None
Either a str acknowledging individuals who contributed to the creation/curation of this dataset OR a list of the individuals’ names as str.
- how_to_acknowledge
list
|str
|None
Either a str describing how to acknowledge this dataset OR a list of publications that should be cited.
- funding
list
|str
|None
List of sources of funding (e.g., grant numbers). Must be a list of str or a single comma separated str like [‘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 or a single comma separated str like [‘a’, ‘b’, ‘c’].
- doi
str
|None
The DOI for the dataset.
- dataset_type
str
Must be either “raw” or “derivative”. Defaults to “raw”.
- 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 field BIDSVersion will be automatically filled by mne_bids.