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=False)

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

pathstr

A path to a folder where the description will be created.

namestr

The name of this BIDS dataset.

data_licensestr | None

The license under which this dataset is published.

authorslist | 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’].

acknowledgementslist | 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_acknowledgelist | str | None

Either a str describing how to acknowledge this dataset OR a list of publications that should be cited.

fundinglist | 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_linkslist | 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’].

doistr | None

The DOI for the dataset.

dataset_typestr

Must be either “raw” or “derivative”. Defaults to “raw”.

overwritebool

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.

verbosebool

Set verbose output to True or False.

Notes

The required field BIDSVersion will be automatically filled by mne_bids.

Examples using mne_bids.make_dataset_description

mne_bids.BIDSPath mne_bids.make_report