.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEBio

.. oe:constnamespace:: OEIridiumCategory

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants that represent the Iridium
   classification. These classifications were taken from the 2012
   paper by Warren *et al.*, which describes the Iridium scoring
   methodology, and includes a database of structures to be used in
   validation of structure-based drug discovery tools [Warren-2012]_.

   .. oe:constant:: HT

   The structure is highly trustworthy.

   .. oe:constant:: MT

   The structure is mildly trustworthy.

   .. oe:constant:: NA

   Not applicable -- no Iridium category has been assigned.

   .. oe:constant:: NT

   The structure is not trustworthy.

   .. seealso::

      * :oe:func:`OEBio::OEGetIridiumCategoryName` function
      * :oe:func:`OEBio::OEGetIridiumCategoryFromName` function
      * :ref:`section_sprucetk_iridium_categorization` section in **OESpruce TK**
