..
   This documentation page is generated during the Sphinx build.
   The underlying code is manually maintained and not autogenerated.

eegdash.dataset.DS006377
========================

InclusionStudy (OpenNeuro ``ds006377``). Access recordings and metadata through EEGDash.

.. rst-class:: sd-badges

:bdg-light:`Modality: ['fnirs']` :bdg-light:`Tasks: 0` :bdg-light:`License: CC0` :bdg-light:`Subjects: 0` :bdg-light:`Recordings: 0` :bdg-light:`Source: openneuro`

Dataset Information
-------------------

.. list-table::
   :widths: 25 75
   :header-rows: 0

   * - Dataset ID
     - ``DS006377``
   * - Title
     - InclusionStudy
   * - Year
     - Unknown
   * - Authors
     - Meryem A. Yücel, Jessica E. Anderson, De'Ja Rogers, Parisa Hajirahimi, Parya Farzam, Yuanyuan Gao, Rini I. Kaplan, Emily J. Braun, Nishaat Mukadam, Sudan Duwadi, Laura Carlton, David Beeler, Lindsay K. Butler, Erin Carpenter, Jaimie Girnis, John Wilson, Vaibhav Tripathi, Yiwen Zhang, Bettina Sorger, Alexander von Lühmann, David C. Somers, Alice Cronin-Golomb, Swathi Kiran, Terry D. Ellis, David A. Boas
   * - License
     - CC0
   * - Citation / DOI
     - `doi:10.18112/openneuro.ds006377.v1.0.2 <https://doi.org/10.18112/openneuro.ds006377.v1.0.2>`__
   * - Source links
     - `OpenNeuro <https://openneuro.org/datasets/ds006377>`__ | `NeMAR <https://nemar.org/dataexplorer/detail?dataset_id=ds006377>`__ | `Source URL <https://openneuro.org/datasets/ds006377/versions/1.0.2>`__

.. dropdown:: Copy-paste BibTeX
   :class-container: sd-shadow-sm
   :class-title: sd-bg-light

   .. code-block:: bibtex

      @dataset{ds006377,
        title = {InclusionStudy},
        author = {Meryem A. Yücel and Jessica E. Anderson and De'Ja Rogers and Parisa Hajirahimi and Parya Farzam and Yuanyuan Gao and Rini I. Kaplan and Emily J. Braun and Nishaat Mukadam and Sudan Duwadi and Laura Carlton and David Beeler and Lindsay K. Butler and Erin Carpenter and Jaimie Girnis and John Wilson and Vaibhav Tripathi and Yiwen Zhang and Bettina Sorger and Alexander von Lühmann and David C. Somers and Alice Cronin-Golomb and Swathi Kiran and Terry D. Ellis and David A. Boas},
        doi = {10.18112/openneuro.ds006377.v1.0.2},
        url = {https://doi.org/10.18112/openneuro.ds006377.v1.0.2},
      }

Highlights
----------

.. grid:: 1 2 3 3
   :gutter: 2

   .. grid-item-card:: Subjects & recordings
      :class-card: sd-border-1

      - Subjects: 0
      - Recordings: 0
      - Tasks: 0

   .. grid-item-card:: Channels & sampling rate
      :class-card: sd-border-1

      - Channels: Unknown
      - Sampling rate (Hz): Unknown
      - Duration (hours): 0

   .. grid-item-card:: Tasks & conditions
      :class-card: sd-border-1

      - Tasks: 0
      - Experiment type: Unknown
      - Subject type: Unknown

   .. grid-item-card:: Files & format
      :class-card: sd-border-1

      - Size on disk: Unknown
      - File count: Unknown
      - Format: Unknown

   .. grid-item-card:: License & citation
      :class-card: sd-border-1

      - License: CC0
      - DOI: doi:10.18112/openneuro.ds006377.v1.0.2

   .. grid-item-card:: Provenance
      :class-card: sd-border-1

      - Source: openneuro
      - OpenNeuro: `ds006377 <https://openneuro.org/datasets/ds006377>`__
      - NeMAR: `ds006377 <https://nemar.org/dataexplorer/detail?dataset_id=ds006377>`__

Quickstart
----------

**Install**

.. code-block:: bash

   pip install eegdash

**Load a recording**

.. code-block:: python

   from eegdash.dataset import DS006377

   dataset = DS006377(cache_dir="./data")
   recording = dataset[0]
   raw = recording.load()

**Filter/query**

.. tab-set::

   .. tab-item:: Basic

      .. code-block:: python

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

   .. tab-item:: Advanced

      .. code-block:: python

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


Quality & caveats
-----------------

- No dataset-specific caveats are listed in the available metadata.

API
---

.. currentmodule:: eegdash.dataset

.. autoclass:: eegdash.dataset.DS006377
   :members: __init__, save
   :show-inheritance:
   :member-order: bysource


See Also
--------

* :class:`eegdash.dataset.EEGDashDataset`
* :mod:`eegdash.dataset`
* `OpenNeuro dataset page <https://openneuro.org/datasets/ds006377>`__
* `NeMAR dataset page <https://nemar.org/dataexplorer/detail?dataset_id=ds006377>`__