From 76200bc5e20361d6cfbbd7696cb2a428d7c9b81b Mon Sep 17 00:00:00 2001 From: longemen3000 Date: Fri, 22 Nov 2024 20:18:29 -0300 Subject: [PATCH] minor readme fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10cf9dd..a4766f1 100644 --- a/README.md +++ b/README.md @@ -87,13 +87,13 @@ ChemicalIdentifiers.load_db!(:inorganic) ``` or if you already have a local database: -``` +```julia using ChemicalIdentifiers filepath = "path/to/my/db.tsv" ChemicalIdentifiers.load_data!(:custom,file = filepath) ChemicalIdentifiers.load_db!(:custom) ``` -`ChemicalIdentifiers.load_data!` will generate a named tuple of file paths (stored in `ChemicalIdentifiers.DATA_INFO`), and `ChemicalIdentifiers.load_db!` will use that data to generate the corresponding Apache Arrow files and store those in a [scratch](https://github.com/JuliaPackaging/Scratch.jl) space (`ChemicalIdentifiers.download_cache`). This download cache can be cleaned (in case a download goes wrong) with `ChemicalIdentifiers.clear_download_cache!()` +`ChemicalIdentifiers.load_data!` will generate a named tuple of file paths (stored in `ChemicalIdentifiers.DATA_INFO`), and `ChemicalIdentifiers.load_db!` will use that data to generate the corresponding Apache Arrow files and store those in a [scratchspace](https://github.com/JuliaPackaging/Scratch.jl) (stored in `ChemicalIdentifiers.download_cache`). This download cache can be cleaned (in case a download goes wrong) with `ChemicalIdentifiers.clear_download_cache!()` The raw databases are then stored in `ChemicalIdentifiers.DATA_DB`. if the data was already processed, then the arrow files are read directly, saving significant loading time.