Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,63 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: cc-by-nc-4.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-nc-4.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Dataset Card for FishBase
|
| 6 |
+
|
| 7 |
+
<!-- Provide a quick summary of the dataset. -->
|
| 8 |
+
|
| 9 |
+
Snapshots of FishBase data tables used by the [rOpenSci package `rfishbase`](https://github.com/ropensci/rfishbase) and the FishBase API.
|
| 10 |
+
|
| 11 |
+
## Dataset Details
|
| 12 |
+
|
| 13 |
+
### Dataset Description
|
| 14 |
+
|
| 15 |
+
<!-- Provide a longer summary of what this dataset is. -->
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
- **Curated by:** Carl Boettiger
|
| 20 |
+
- **License:** CC-BY-NC, FishBase.org Team
|
| 21 |
+
|
| 22 |
+
### Dataset Sources [optional]
|
| 23 |
+
|
| 24 |
+
<!-- Provide the basic links for the dataset. -->
|
| 25 |
+
|
| 26 |
+
- **Repository:** [More Information Needed]
|
| 27 |
+
- **Paper [optional]:** [More Information Needed]
|
| 28 |
+
- **Demo [optional]:** [More Information Needed]
|
| 29 |
+
|
| 30 |
+
## Uses
|
| 31 |
+
|
| 32 |
+
<!-- Address questions around how the dataset is intended to be used. -->
|
| 33 |
+
|
| 34 |
+
### Direct Use
|
| 35 |
+
|
| 36 |
+
This data is provided to facilitate access to fishbase statistics through `rfishbase`.
|
| 37 |
+
Curation has evolved over the past decade and now provides basically direct access to versioned snapshots of the fishbase backend data.
|
| 38 |
+
|
| 39 |
+
[More Information Needed]
|
| 40 |
+
|
| 41 |
+
### Out-of-Scope Use
|
| 42 |
+
|
| 43 |
+
Reuse of this data is not licensed for commerical applications. Developers should contact the FishBase team directly. See <https://fishbase.org> for details.
|
| 44 |
+
|
| 45 |
+
## Dataset Structure
|
| 46 |
+
|
| 47 |
+
Data provided here are raw CSV and parquet exports from the MySQL database backend powering <https://fishbase.org> and its sister site, <https://sealifebase.org>.
|
| 48 |
+
Please note that there are many tables here which have evolved over decades and were not developed with the intent of ever supporting direct access by end users.
|
| 49 |
+
The data structure can be highly unintuitive and common tasks may require joins across multiple tables. These files represent a snapshot in time as indicated
|
| 50 |
+
by the version numbers (e.g. v24.07 is data snapshot dated to July of 2024).
|
| 51 |
+
|
| 52 |
+
## Dataset Creation
|
| 53 |
+
|
| 54 |
+
Dataset creation relies on ingesting a MySQL dump provided roughly annually from the FishBase team to this maintainer. Current process imports this into
|
| 55 |
+
a MySQL (mariadb) server in docker, connects a the `duckdb` `mysql` extension and exports as parquet and csv, as shown in the `creation.py` script.
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
|
| 59 |
+
### Source Data
|
| 60 |
+
|
| 61 |
+
See <https://fishbase.org> for details.
|
| 62 |
+
|
| 63 |
+
|