data_source.reaction_pattern.miscellaneous.utility ================================================== .. py:module:: data_source.reaction_pattern.miscellaneous.utility .. autoapi-nested-parse:: The ``data_source.reaction_pattern.miscellaneous.utility`` package initialization module. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/data_source/reaction_pattern/miscellaneous/utility/download/index /autoapi/data_source/reaction_pattern/miscellaneous/utility/extraction/index /autoapi/data_source/reaction_pattern/miscellaneous/utility/formatting/index Classes ------- .. autoapisummary:: data_source.reaction_pattern.miscellaneous.utility.MiscellaneousReactionPatternDataSourceDownloadUtility data_source.reaction_pattern.miscellaneous.utility.MiscellaneousReactionPatternDataSourceExtractionUtility data_source.reaction_pattern.miscellaneous.utility.MiscellaneousReactionPatternDataSourceFormattingUtility Package Contents ---------------- .. py:class:: MiscellaneousReactionPatternDataSourceDownloadUtility The miscellaneous chemical reaction pattern data source download utility class. .. py:method:: download_v_retro_transform_db_by_20180421_avramova_s_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_retro_transform_db_by_20180421_avramova_s_et_al` version of the data source. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_dingos_by_20190701_button_a_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_dingos_by_20190701_button_a_et_al` version of the data source. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_auto_template_by_20240627_chen_l_and_li_y(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_auto_template_by_20240627_chen_l_and_li_y` version of the data source. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:class:: MiscellaneousReactionPatternDataSourceExtractionUtility The miscellaneous chemical reaction pattern data source extraction utility class. .. py:method:: extract_v_auto_template_by_20240627_chen_l_and_li_y(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_auto_template_by_20240627_chen_l_and_li_y` version of the data source. :parameter input_directory_path: The path to the input directory where the data is downloaded. :parameter output_directory_path: The path to the output directory where the data should be extracted. .. py:class:: MiscellaneousReactionPatternDataSourceFormattingUtility The miscellaneous chemical reaction pattern data source formatting utility class. .. py:method:: format_v_retro_transform_db_by_20180421_avramova_s_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_retro_transform_db_by_20180421_avramova_s_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_dingos_by_20190701_button_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_dingos_by_20190701_button_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_auto_template_by_20240627_chen_l_and_li_y(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_auto_template_by_20240627_chen_l_and_li_y` 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.