create_dataset_description#

neurocaps.utils.create_dataset_description(dataset_name, bids_version='1.0.0', derivative=False)[source]#

Generate Dataset Description.

Creates a dictionary containing the name and BIDs version of a dataset.

Added in version 0.34.1.

Parameters:

  • dataset_name (str) – Name of the dataset.

  • bids_version (str, default=”1.0.0”) – Version of the BIDS dataset.

  • derivative (bool, default=False) – Determines if “GeneratedBy” key is added to dictionary.

Returns:

dict – The dataset description dictionary