Variables
=========

.. currentmodule:: corr_vars.core.extract

Base Variable Class
-------------------

.. autoclass:: Variable
   :members:
   :undoc-members:
   :show-inheritance:

Native Variables
----------------

.. autoclass:: NativeDynamic
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: NativeStatic
   :members:
   :undoc-members:
   :show-inheritance:


Derived Variables
----------------

.. autoclass:: DerivedDynamic
   :members:
   :undoc-members:
   :show-inheritance:


.. autoclass:: DerivedStatic
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: ComplexVariable
   :members:
   :undoc-members:
   :show-inheritance:

.. Examples
.. --------

.. Native Static Variable
.. ^^^^^^^^^^^^^^^^^^^^^^^

.. .. code-block:: python

..    # Create a native static variable
..    var = NativeStatic(
..        "age",
..        tmin="hospital_admission",
..        tmax="hospital_discharge"
..    )
   
..    # Extract data
..    data = var.extract(cohort)

.. Native Dynamic Variable
.. ^^^^^^^^^^^^^^^^^^^^^^^

.. .. code-block:: python

..    # Create a native dynamic variable
..    var = NativeDynamic(
..        "heart_rate",
..        tmin="icu_admission",
..        tmax="icu_discharge"
..    )
   
..    # Extract time series data
..    data = var.extract(cohort)