:orphan:

.. _tutorials:

Tutorials
=========

Each tutorial runs on real data (MNE's ``sample`` recording, downloaded on
first use) and shows the figures meeg-utils draws. Download any of them as
a Python script or a Jupyter notebook at the bottom of its page.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial takes one EEG recording through the whole of meeg-utils: check how well it was recorded, clean it with a recommended pipeline, look at what every step did, cut it into epochs and save the result.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_plot_00_quickstart_thumb.png
    :alt:

  :doc:`/auto_tutorials/plot_00_quickstart`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quickstart: from a raw recording to clean epochs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Before cleaning a recording, check how well it was made: a flat channel, a loose EOG electrode, a head that moved, or a sidecar that disagrees with the data are better found the day the data were recorded than months later.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_plot_10_quality_control_thumb.png
    :alt:

  :doc:`/auto_tutorials/plot_10_quality_control`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Acquisition quality control</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A pipeline is a list of named steps. Each step is a small scikit-learn style estimator: its parameters are set when it is created, fit learns what it needs from a recording, transform applies it, and afterwards it reports what it did (``qc_``) and draws it (``plot``).">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_plot_20_pipelines_thumb.png
    :alt:

  :doc:`/auto_tutorials/plot_20_pipelines`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Build and adjust a pipeline</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Preprocessing works on each run separately. Epoching is a second stage, applied to each preprocessed run; the epochs of a session&#x27;s runs are then combined. This tutorial cuts MNE&#x27;s sample EEG into epochs around the auditory and visual stimuli, repairs or rejects the bad ones with autoreject, and combines two runs.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_plot_30_epochs_thumb.png
    :alt:

  :doc:`/auto_tutorials/plot_30_epochs`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Epochs, artifact rejection and combining runs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For a study, the same steps run on every recording of a BIDS dataset: check them all, preprocess every run, epoch it, and combine the runs of each session. meeg_utils.Dataset selects the recordings and meeg_utils.process_dataset takes them through every stage, resuming an interrupted batch and collecting failures. The meu command does the same from a terminal.">

.. only:: html

  .. image:: /auto_tutorials/images/thumb/sphx_glr_plot_40_bids_datasets_thumb.png
    :alt:

  :doc:`/auto_tutorials/plot_40_bids_datasets`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Whole BIDS datasets</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_tutorials/plot_00_quickstart
   /auto_tutorials/plot_10_quality_control
   /auto_tutorials/plot_20_pipelines
   /auto_tutorials/plot_30_epochs
   /auto_tutorials/plot_40_bids_datasets



.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_