biggr_models.queries.reaction_queries
=====================================

.. py:module:: biggr_models.queries.reaction_queries


Attributes
----------

.. autoapisummary::

   biggr_models.queries.reaction_queries.REF_ANNOTATIONS_SUBQ
   biggr_models.queries.reaction_queries.REACTION_ANNOTATIONS_SUBQ


Functions
---------

.. autoapisummary::

   biggr_models.queries.reaction_queries.get_universal_reactions_count
   biggr_models.queries.reaction_queries.get_universal_reactions
   biggr_models.queries.reaction_queries.get_model_reactions_count
   biggr_models.queries.reaction_queries.get_model_reactions
   biggr_models.queries.reaction_queries.get_universal_reaction_and_models
   biggr_models.queries.reaction_queries.get_reactions_for_model
   biggr_models.queries.reaction_queries.get_model_list_for_reaction
   biggr_models.queries.reaction_queries.get_reference_for_reaction
   biggr_models.queries.reaction_queries.get_model_reaction
   biggr_models.queries.reaction_queries.get_reaction
   biggr_models.queries.reaction_queries.get_reaction_object


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

.. py:function:: get_universal_reactions_count(session)

   Return the number of universal reactions.


.. py:function:: get_universal_reactions(session, page=None, size=None, sort_column=None, sort_direction='ascending', **kwargs)

   Get universal reactions.

   :param session:
   :type session: An ome session object.
   :param page:
   :type page: The page, or None for all pages.
   :param size:
   :type size: The page length, or None for all pages.
   :param sort_column:
   :type sort_column: The name of the column to sort. Must be one of 'bigg_id', 'name'.
   :param sort_direction:
   :type sort_direction: Either 'ascending' or 'descending'.

   :rtype: A list of objects with keys 'bigg_id', 'name'.


.. py:function:: get_model_reactions_count(model_bigg_id, session)

   Count the model reactions.


.. py:function:: get_model_reactions(model_bigg_id, session, page=None, size=None, sort_column=None, sort_direction='ascending', **kwargs)

   Get model reactions.

   :param model_bigg_id:
   :type model_bigg_id: The bigg id of the model to retrieve reactions.
   :param session:
   :type session: An ome session object.
   :param page:
   :type page: The page, or None for all pages.
   :param size:
   :type size: The page length, or None for all pages.
   :param sort_column:
   :type sort_column: The name of the column to sort. Must be one of 'bigg_id', 'name',
   :param 'model_bigg_id':
   :param and 'organism'.:
   :param sort_direction:
   :type sort_direction: Either 'ascending' or 'descending'.

   :returns: * *A list of objects with keys 'bigg_id', 'name', 'model_bigg_id', and*
             * *'organism'.*


.. py:function:: get_universal_reaction_and_models(session: sqlalchemy.orm.Session, reaction_bigg_id: str) -> Dict[str, Any]

.. py:function:: get_reactions_for_model(model_bigg_id, session)

.. py:function:: get_model_list_for_reaction(reaction_bigg_id, session)

.. py:function:: get_reference_for_reaction(reaction_bigg_id, session)

.. py:function:: get_model_reaction(model_bigg_id, biggr_id, session)

   Get details about this reaction in the given model. Returns multiple
   results when the reaction appears in the model multiple times.



.. py:function:: get_reaction(reaction_bigg_id, session)

.. py:data:: REF_ANNOTATIONS_SUBQ

.. py:data:: REACTION_ANNOTATIONS_SUBQ

.. py:function:: get_reaction_object(session: sqlalchemy.orm.Session, id: biggr_models.queries.utils.IDType, load_annotations: bool = True) -> Dict[str, Any]