ncsw_data.source.reaction.miscellaneous.utility.formatting
==========================================================

.. py:module:: ncsw_data.source.reaction.miscellaneous.utility.formatting

.. autoapi-nested-parse::

   The ``ncsw_data.source.reaction.miscellaneous.utility`` package ``formatting`` module. 



Classes
-------

.. autoapisummary::

   ncsw_data.source.reaction.miscellaneous.utility.formatting.MiscellaneousReactionDataSourceFormattingUtility


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

.. py:class:: MiscellaneousReactionDataSourceFormattingUtility

   The miscellaneous chemical reaction data source formatting utility class. 


   .. py:method:: format_v_20131008_kraut_h_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from the `v_20131008_kraut_h_et_al` version of the data source.

      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.



   .. py:method:: format_v_20161014_wei_j_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from the `v_20161014_wei_j_n_et_al` version of the data source.

      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.



   .. py:method:: format_v_20200508_grambow_c_et_al(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from a `v_*_20200508_grambow_c_et_al` version of the data source.

      :parameter version: The version of the data source.
      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.



   .. py:method:: format_v_golden_dataset_by_20211102_lin_a_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from the `v_golden_dataset_by_20211102_lin_a_et_al` version of the data source.

      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.



   .. py:method:: format_v_rdb7_by_20220718_spiekermann_k_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from the `v_rdb7_by_20220718_spiekermann_k_et_al` version of the data source.

      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.



   .. py:method:: format_v_orderly(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from a `v_orderly_*` version of the database.

      :parameter version: The version of the chemical reaction database.
      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.