ncsw_data.source.reaction.uspto.utility.extraction ================================================== .. py:module:: ncsw_data.source.reaction.uspto.utility.extraction .. autoapi-nested-parse:: The ``ncsw_data.source.reaction.uspto.utility`` package ``extraction`` module. Classes ------- .. autoapisummary:: ncsw_data.source.reaction.uspto.utility.extraction.USPTOReactionDatasetExtractionUtility Module Contents --------------- .. py:class:: USPTOReactionDatasetExtractionUtility The `United States Patent and Trademark Office (USPTO) `_ chemical reaction dataset extraction utility class. .. py:method:: extract_v_1976_to_2013_rsmi_by_20121009_lowe_d_m(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1976_to_2013_rsmi_by_20121009_lowe_d_m` version of the dataset. :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:method:: extract_v_50k_by_20141226_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_50k_by_20141226_schneider_n_et_al` version of the dataset. :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:method:: extract_v_50k_by_20161122_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_50k_by_20161122_schneider_n_et_al` version of the dataset. :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:method:: extract_v_15k_by_20170418_coley_c_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_15k_by_20170418_coley_c_w_et_al` version of the dataset. :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:method:: extract_v_1976_to_2016_by_20121009_lowe_d_m(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from a `v_1976_to_2016_*_by_20121009_lowe_d_m` version of the dataset. :parameter version: The version of the dataset. :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:method:: extract_v_480k_or_mit_by_20171204_jin_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_480k_or_mit_by_20171204_jin_w_et_al` version of the dataset. :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:method:: extract_v_by_20180622_schwaller_p_et_al(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from a `v_*_by_20180622_schwaller_p_et_al` version of the dataset. :parameter version: The version of the dataset. :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:method:: extract_v_lef_by_20181221_bradshaw_j_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_lef_by_20181221_bradshaw_j_et_al` version of the dataset. :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:method:: extract_v_1k_tpl_by_20210128_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1k_tpl_by_20210128_schwaller_p_et_al` version of the dataset. :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:method:: extract_v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al` version of the dataset. :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.