Datasets:
Add links for new files and description of final curation process.
Browse files
README.md
CHANGED
@@ -81,15 +81,15 @@ English, Latin
|
|
81 |
|
82 |
|
83 |
**Notes:**
|
84 |
-
- The notebooks that generated these files and stats are included in the `notebooks` folder
|
85 |
-
- The original Jiggins Zenodo Master file was compiled from the CSVs provided with the included Zenodo records from the Butterfly Genetics Group. Christopher Lawrence selected which of these provided columns to include. Further processing and standardization (all documented in the Jupyter Notebooks) was performed by Elizabeth Campolongo.
|
86 |
- Taxonomic information for records [5526257](https://zenodo.org/record/5526257), [2554218](https://zenodo.org/record/2554218), and [2555086](https://zenodo.org/record/2555086) was recovered from information on their Zenodo pages, as the provided CSVs did not contain that information.
|
87 |
- Be advised that there may be overlap between images in [record 2548678](https://zenodo.org/records/2548678) and [record 3082688](https://zenodo.org/records/3082688).
|
88 |
-
- The `scripts` folder has a download and checksum script
|
89 |
- Images are downloaded to the provided images directory with subfolders labeled by the `Taxonomic_Name`, with filenames `<X>_<Image_name>`.
|
90 |
- The checksum script is called by `download_jiggins_subset.py` to generate an MD5 for all downloaded images and creates a CSV with `filepath`, `filename`, and `md5` columns in the same folder as the source CSV (named `<source CSV>_checksums.csv`). This helps to ensure FAIR and Reproducible results, though this will _**not**_ distinguish between RAW and JPG versions of the same image.
|
91 |
- A log of the download is also generated in the same folder as the source CSV (named `<source CSV>_log.json`).
|
92 |
-
- `metadata/Missing_taxa_Jiggins_Zenodo_Master.csv` contains a record of the images that did not have easily reconcilable taxonomic information (see `notebooks/
|
93 |
|
94 |
### Data Instances
|
95 |
|
@@ -175,6 +175,8 @@ These images are a subset of the [Butterfly Genetics Group's Cambridge butterfly
|
|
175 |
|
176 |
Data is pulled from the Zenodo Records in [`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/licenses.json). This file also contains full citation information for all records.
|
177 |
|
|
|
|
|
178 |
|
179 |
#### Initial Data Collection and Annotation
|
180 |
|
@@ -195,7 +197,7 @@ None
|
|
195 |
- There are multiple images of the same specimen for many specimens; sometimes this is due to different views (eg., dorsal or ventral side), sometimes it is due to JPG copies of the RAW photos, though it seems it is also sometimes that new photos were taken of the same specimen at a different times.
|
196 |
- The master files contain only images that were determined to be unique (at the pixel level) through MD5 checksum. This does _**not**_ guarantee that there are not images that are cropped copies of other photos. For instance, [record 2553977](https://zenodo.org/records/2553977) has a number of images with `_cut_` in their name, some of which are close-up crops of the butterfly wings (though not all, some are just close-ups of the full butterfly).
|
197 |
|
198 |
-
Please see the [`deduplication_process/README.md`]() for more details on the deduplication process and recommendations on how to split this data effectively without data leakage.
|
199 |
|
200 |
|
201 |
## Additional Information
|
@@ -211,13 +213,13 @@ Please see the [`deduplication_process/README.md`]() for more details on the ded
|
|
211 |
|
212 |
The data (images and text) are all licensed under [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/). Each image and text in this dataset is provided under the least restrictive terms allowed by its licensing requirements as provided to us (i.e, we impose no additional restrictions past those specified by this license on the original source files). Modified images are only restricted by this original license.
|
213 |
|
214 |
-
Images can be matched to their source record through the `zenodo_link` or `record_number` column in the Master CSVs to the `url` or `record_number` in the licenses.json file, respectively.
|
215 |
|
216 |
### Citation Information
|
217 |
|
218 |
Christopher Lawrence, Chris Jiggins, Butterfly Genetics Group (University of Cambridge), Elizabeth G. Campolongo. (2024). Jiggins Heliconius Collection. Hugging Face. https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection.
|
219 |
|
220 |
-
If you use this dataset, please cite the original datasets (citations for all 29 included Zenodo records are in [jiggins.bib]()) as well as this curated subset.
|
221 |
|
222 |
### Contributions
|
223 |
|
|
|
81 |
|
82 |
|
83 |
**Notes:**
|
84 |
+
- The notebooks that generated these files and stats are included in the `notebooks` folder, their only requirement is `pandas`.
|
85 |
+
- The [original Jiggins Zenodo Master file](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/Jiggins_Zenodo_Master.csv) was compiled from the CSVs provided with the included Zenodo records from the Butterfly Genetics Group. Christopher Lawrence selected which of these provided columns to include. Further processing and standardization (all documented in the Jupyter Notebooks) was performed by Elizabeth Campolongo.
|
86 |
- Taxonomic information for records [5526257](https://zenodo.org/record/5526257), [2554218](https://zenodo.org/record/2554218), and [2555086](https://zenodo.org/record/2555086) was recovered from information on their Zenodo pages, as the provided CSVs did not contain that information.
|
87 |
- Be advised that there may be overlap between images in [record 2548678](https://zenodo.org/records/2548678) and [record 3082688](https://zenodo.org/records/3082688).
|
88 |
+
- The `scripts` folder has a download and checksum script, their only requirement is `pandas`.
|
89 |
- Images are downloaded to the provided images directory with subfolders labeled by the `Taxonomic_Name`, with filenames `<X>_<Image_name>`.
|
90 |
- The checksum script is called by `download_jiggins_subset.py` to generate an MD5 for all downloaded images and creates a CSV with `filepath`, `filename`, and `md5` columns in the same folder as the source CSV (named `<source CSV>_checksums.csv`). This helps to ensure FAIR and Reproducible results, though this will _**not**_ distinguish between RAW and JPG versions of the same image.
|
91 |
- A log of the download is also generated in the same folder as the source CSV (named `<source CSV>_log.json`).
|
92 |
+
- `metadata/Missing_taxa_Jiggins_Zenodo_Master.csv` contains a record of the images that did not have easily reconcilable taxonomic information (see `notebooks/Data-gen-0-3.ipynb` for more information on this data). There are 1,630 such images distributed across 18 records.
|
93 |
|
94 |
### Data Instances
|
95 |
|
|
|
175 |
|
176 |
Data is pulled from the Zenodo Records in [`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/licenses.json). This file also contains full citation information for all records.
|
177 |
|
178 |
+
The original Master file, created by Christopher, was fed into notebook Data-gen-0-1, and further processed in Data-gen-0-2 and Data-gen-0-3. The next data generation step (deduplication by MD5) involved downloading all images in `Jiggins_Zenodo_Img_Master_3477891Patch.csv` (created in Data-gen-1-1). MD5s of all downloaded images were taken and the results were explored in the EDA-DL series of notebooks; information and conclusions from this EDA are documented in the [`deduplication_process` README](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/deduplication_process/README.md). The outline described there was then implemented in the [Data-gen-1-2 notebook]((https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/notebooks/Data-gen-1-2.ipynb)), regenerating all current datasets.
|
179 |
+
|
180 |
|
181 |
#### Initial Data Collection and Annotation
|
182 |
|
|
|
197 |
- There are multiple images of the same specimen for many specimens; sometimes this is due to different views (eg., dorsal or ventral side), sometimes it is due to JPG copies of the RAW photos, though it seems it is also sometimes that new photos were taken of the same specimen at a different times.
|
198 |
- The master files contain only images that were determined to be unique (at the pixel level) through MD5 checksum. This does _**not**_ guarantee that there are not images that are cropped copies of other photos. For instance, [record 2553977](https://zenodo.org/records/2553977) has a number of images with `_cut_` in their name, some of which are close-up crops of the butterfly wings (though not all, some are just close-ups of the full butterfly).
|
199 |
|
200 |
+
Please see the [`deduplication_process/README.md`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/deduplication_process/README.md) for more details on the deduplication process and recommendations on how to split this data effectively without data leakage.
|
201 |
|
202 |
|
203 |
## Additional Information
|
|
|
213 |
|
214 |
The data (images and text) are all licensed under [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/). Each image and text in this dataset is provided under the least restrictive terms allowed by its licensing requirements as provided to us (i.e, we impose no additional restrictions past those specified by this license on the original source files). Modified images are only restricted by this original license.
|
215 |
|
216 |
+
Images can be matched to their source record through the `zenodo_link` or `record_number` column in the Master CSVs to the `url` or `record_number` in the [`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/licenses.json) file, respectively.
|
217 |
|
218 |
### Citation Information
|
219 |
|
220 |
Christopher Lawrence, Chris Jiggins, Butterfly Genetics Group (University of Cambridge), Elizabeth G. Campolongo. (2024). Jiggins Heliconius Collection. Hugging Face. https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection.
|
221 |
|
222 |
+
If you use this dataset, please cite the original datasets (bibtex citations for all 29 included Zenodo records are in [`jiggins.bib`]([`licenses.json`](https://huggingface.co/datasets/imageomics/Jiggins_Heliconius_Collection/blob/main/metadata/jiggins.bib))) as well as this curated subset.
|
223 |
|
224 |
### Contributions
|
225 |
|