==================================
Tutorial of Data Extraction Module
==================================

| Data Extraction Module has the functions to extract required information.
| The functions in this module receive the instance of EventStream or converted class and return the extracted result.


.. image:: extract_example.png
 :scale: 50%
 :align: center



| The functions in below table are available now.
| The documentation is in :doc:`../scripts/data_extraction`

+-----------------------------+------------------------------------------------------------------------------------------------------------+
| function                    | description                                                                                                |
+=============================+============================================================================================================+
|                             | |                                                                                                          |
| select_user                 | | Extract the log of specific user(s)                                                                      |
|                             | | For *EventStream*, *OperationCount*, *PageWiseAggregation*, *PageTransition*, and *TimeRangeAggregation* |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
|                             | |                                                                                                          |
| select_contents             | | Extract the log of specific content(s)                                                                   |
|                             | | For *EventStream*, *OperationCount*, *PageWiseAggregation*, *PageTransition*, and *TimeRangeAggregation* |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_operation            | Extract the log of specific operation(s). For *EventStream*.                                               |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_time                 | Extract the log recorded at specific time                                                                  |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_by_lecture_time      | Extract the log after, before, or during lecture(s). For *EventStream*.                                    |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_page                 | Extract the log recorded in specific page(s). For *EventStream*.                                           |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_marker_type          | Extract the log of specific marker type. For *EventStream*.                                                |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_device               | Extract the log recorded by specific device. For *EventStream*.                                            |
+-----------------------------+------------------------------------------------------------------------------------------------------------+
| select_memo_length          | Extract the log of specific length of notes. For *EventStream*.                                            |
+-----------------------------+------------------------------------------------------------------------------------------------------------+

Example
=============

.. toctree::
   :maxdepth: 1

   ../jupyter_examples/example_data_extraction