clinicaio.subclasses.dataset
============================

.. py:module:: clinicaio.subclasses.dataset

.. autoapi-nested-parse::

   BIDS parser.



Attributes
----------

.. autoapisummary::

   clinicaio.subclasses.dataset.LOGGER


Exceptions
----------

.. autoapisummary::

   clinicaio.subclasses.dataset.BIDSDatasetError


Classes
-------

.. autoapisummary::

   clinicaio.subclasses.dataset.BIDSDataset


Module Contents
---------------

.. py:data:: LOGGER

.. py:exception:: BIDSDatasetError

   Bases: :py:obj:`clinicaio.exception.BIDSPathError`


   Exceptions raised by the parser.


.. py:class:: BIDSDataset

   Bases: :py:obj:`clinicaio.directory.BIDSDirectory`


   BIDS dataset parser.


   .. py:attribute:: SUBCLASSES_BY_ENTITY


   .. py:method:: dataset_description()

      Data from the dataset_description.json file.



   .. py:property:: name
      :type: str


      The name of the dataset. REQUIRED.



   .. py:property:: bids_version
      :type: str


      The version of the BIDS standard that was used. REQUIRED.