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

.. oe:namespace:: OESaiph

.. meta::
   :keywords: read_record_file_to_dataframe

.. oe:function:: read_record_file_to_dataframe

   .. attention::

      |PRELIMINARY-API|
      |PYTHONONLY|

   .. oe:api::

      def read_record_file_to_dataframe(path: str, serializable: bool = False,
                                        pandasCheck: bool = True) -> Union["Series", "DataFrame"]

   Creates a pandas DataFrame from any file that passes the :oe:func:`OEChem::OEIsReadable` check.
   The user is required to have pandas installed in their Python environment. If `serializable` is
   set true, then the DataFrame will contain all non-POD types as bytes.
