DS004595: eeg dataset, 53 subjects#

EEG: RL Task (3-Armed Bandit) with alcohol cues in hazardous drinkers and ctls

Access recordings and metadata through EEGDash.

Citation: Ethan Campbell, James F Cavanagh (2023). EEG: RL Task (3-Armed Bandit) with alcohol cues in hazardous drinkers and ctls. 10.18112/openneuro.ds004595.v1.0.0

Modality: eeg Subjects: 53 Recordings: 53 License: CC0 Source: openneuro Citations: 1.0

Metadata: Complete (100%)

Quickstart#

Get Started

Install

pip install eegdash

Access the data

from eegdash.dataset import DS004595

dataset = DS004595(cache_dir="./data")
# Get the raw object of the first recording
raw = dataset.datasets[0].raw
print(raw.info)

Query & Filter

Filter by subject

dataset = DS004595(cache_dir="./data", subject="01")

Advanced query

dataset = DS004595(
    cache_dir="./data",
    query={"subject": {"$in": ["01", "02"]}},
)

Iterate recordings

for rec in dataset:
    print(rec.subject, rec.raw.info['sfreq'])

Cite This Dataset

If you use this dataset in your research, please cite the original authors.

BibTeX

@dataset{ds004595,
  title = {EEG: RL Task (3-Armed Bandit) with alcohol cues in hazardous drinkers and ctls},
  author = {Ethan Campbell and James F Cavanagh},
  doi = {10.18112/openneuro.ds004595.v1.0.0},
  url = {https://doi.org/10.18112/openneuro.ds004595.v1.0.0},
}

About This Dataset#

RL task (3-armed bandit) with alcohol vs. beverage cues in N=53 Community participants. Data collected from 2019-2021 in the CRCL at UNM. The paper [Campbell, E., Singh, G., Claus, E.D., Witkiewitz,K., Costa, V.D., Hogeveen, J; & Cavanagh, J.F. Electrophysiological markers of aberrant cue-specific exploration in hazardous drinkers] Should be coming out in print soonish. Your best bet for understanding this task would be to read that paper first. For more info on triggers and outputs, see BEH_EXPLAIN.m file in code folder. - James F Cavanagh 03/06/2023

Dataset Information#

Dataset ID	`DS004595`
Title	EEG: RL Task (3-Armed Bandit) with alcohol cues in hazardous drinkers and ctls
Author (year)	`Campbell2023`
Canonical	—
Importable as	`DS004595`, `Campbell2023`
Year	2023
Authors	Ethan Campbell, James F Cavanagh
License	CC0
Citation / DOI	doi:10.18112/openneuro.ds004595.v1.0.0
Source links	OpenNeuro \| NeMAR \| Source URL

Found an issue with this dataset?

If you encounter any problems with this dataset (missing files, incorrect metadata, loading errors, etc.), please let us know!

Report an Issue on GitHub

Technical Details#

Subjects & recordings

Subjects: 53
Recordings: 53
Tasks: 1

Channels & sampling rate

Channels: 66
Sampling rate (Hz): 500.0
Duration (hours): 17.077527777777778

Electrode Layout#

Electrode layout — EEG · 59 sensors — 59 channels

Dataset Statistics#

Age distribution (n=53, range 18–55 yr)

152025303540455055

Sex distribution

30

23

Female Male Total: 53

Channel counts: 66 ch (n=53 recordings)

Sampling frequencies: 500.0 Hz (n=53 recordings)

Total recording duration: 17 h 4 min

NEMAR Processing Statistics#

The plots below are generated by NEMAR’s automated EEG pipeline. The histogram shows pipeline success for data cleaning and ICA decomposition, the percentage of data frames and EEG channels retained after artefact removal, line noise per channel (RMS, dB), and the age/gender distribution of participants.

HED event descriptors word cloud

File Explorer#

Browse the BIDS file structure of this dataset. Records are fetched on demand from the EEGDash catalog the first time you open the explorer.

Files: —

Size: —

Subjects: —

Click to load file structure…

API Reference#

Use the DS004595 class to access this dataset programmatically.

class eegdash.dataset.DS004595(cache_dir: str, query: dict | None = None, s3_bucket: str | None = None, **kwargs)[source]#

Bases: EEGDashDataset

EEG: RL Task (3-Armed Bandit) with alcohol cues in hazardous drinkers and ctls

Study:: ds004595 (OpenNeuro)
Author (year):: Campbell2023
Canonical:: —

Also importable as: DS004595, Campbell2023.

Modality: eeg. Subjects: 53; recordings: 53; tasks: 1.

Parameters:

cache_dir (str | Path) – Directory where data are cached locally.
query (dict | None) – Additional MongoDB-style filters to AND with the dataset selection. Must not contain the key dataset.
s3_bucket (str | None) – Base S3 bucket used to locate the data.
**kwargs (dict) – Additional keyword arguments forwarded to EEGDashDataset.

data_dir#

Local dataset cache directory (cache_dir / dataset_id).

Type:: Path

query#

Merged query with the dataset filter applied.

Type:: dict

records#

Metadata records used to build the dataset, if pre-fetched.

Type:: list[dict] | None

Notes

Each item is a recording; recording-level metadata are available via dataset.description. query supports MongoDB-style filters on fields in ALLOWED_QUERY_FIELDS and is combined with the dataset filter. Dataset-specific caveats are not provided in the summary metadata.

References

OpenNeuro dataset: https://openneuro.org/datasets/ds004595 NeMAR dataset: https://nemar.org/dataexplorer/detail?dataset_id=ds004595 DOI: https://doi.org/10.18112/openneuro.ds004595.v1.0.0 NEMAR citation count: 1

Examples

>>> from eegdash.dataset import DS004595
>>> dataset = DS004595(cache_dir="./data")
>>> recording = dataset[0]
>>> raw = recording.load()

__init__(cache_dir: str, query: dict | None = None, s3_bucket: str | None = None, **kwargs)[source]#

save(path: str, overwrite: bool = False, offset: int = 0)[source]#

Save datasets to files by creating one subdirectory for each dataset:

path/
    0/
        0-raw.fif | 0-epo.fif
        description.json
        raw_preproc_kwargs.json (if raws were preprocessed)
        window_kwargs.json (if this is a windowed dataset)
        window_preproc_kwargs.json  (if windows were preprocessed)
        target_name.json (if target_name is not None and dataset is raw)
    1/
        1-raw.fif | 1-epo.fif
        description.json
        raw_preproc_kwargs.json (if raws were preprocessed)
        window_kwargs.json (if this is a windowed dataset)
        window_preproc_kwargs.json  (if windows were preprocessed)
        target_name.json (if target_name is not None and dataset is raw)