Update README.md

README.md

@@ -54,30 +54,53 @@ tags:
 - Book reviews
 ---
 
-Listing of >7k books I've read over the last few years. If you don't believe me, here's a [video](https://www.youtube.com/watch?v=zoVRKlgn9jk) of my occasional reading activity (haters gonna say it's fake).
+Listing of the >7k books I've read recently. Some claim it's actually data scraped from website [*Perlentaucher*](https://www.perlentaucher.de). Which you believe is up to you, but here's a [video](https://www.youtube.com/watch?v=koPSzQWzwno) of my occasional reading activity (haters gonna say it's fake).
 
 ----
 
+# Dataset card
+
+## Dataset Description
+
 The data set contains information of books that have been reviewed at least once. 
 The reviews are received from reputable German print media such as the *Frankfurter Allgemeine Zeitung* (FAZ), *Süddeutsche Zeitung* (SZ), *Die Zeit*, etc. and other serious broadcasters such as *Deutschlandfunk Kultur*.
 Those reviews are collected by the culture magazine [*Perlentaucher*](https://www.perlentaucher.de) and labeled as *read a lot* when there are at least three reviews of a book.
 
 [*Perlentaucher*](https://www.perlentaucher.de) publishes on a daily basis since the year 2000, except for German Sun- and holidays. On average, there are about *M*=12 (*SD*=5) bookentries per day.
-Data was harvested for all entries starting from March 15, 2000 to May 16, 2024. In total, the data set consists of 89,766 rows for 7,349 days and 14 columns.
+Data was harvested for all entries starting from March 15, 2000 to May 18, 2024. In total, the data set consists of 89,790 rows for 7,351 days and 15 columns.
+    
+## Variables overview
 
-**Variables overview:**
-
-  - `date`: the pubication day of book review (as Pandas `timestamp[ns]`, `YYYY-MM-DD`)
-  - `relevant`: boolean, whether the book is relevant (i.e. marked as *read a lot*, dtype: `bool`)
+  - `date`: the publication day of book review (dtype: `date32`, `YYYY-MM-DD`)
   - `author`: the author of the book (dtype: `string`)
   - `title`: the title of the book (dtype: `string`)
-  - `ISBN`: the International Standard Book Number, ISBN-13 (dtype: `int64`)
-  - `type`: the type of the book, e.g. soft- or hardcover (German labelling!) or if it is not a book, the type of medium (dtype: `string`)
-  - `pages`: the number of book pages; `NaN` for other types such as audio files (dtype: `int64`)
-  - `price`: the price of the book in Euros (dtype: `float64`)
+  - `ISBN`: the International Standard Book Number, ISBN-13 in normalized form (i.e. hyphens removed); correctness has been tested via check digit; missing/incorrect numbers have been corrected manually (dtype: `string`)
+  - `price`: the price of the book in euros (`decimal128(6, 2)`, i.e. `scale = 2` for cents)
+  - `n_pages`: the number of book pages; nan for other types such as audio files (dtype: `uint16`)
+  - `n_reviews`: the number of review notes as an indicator whether the book is relevant; lumped to 1 for *n*<3 notes (dtype: `uint8`)
   - `content`: the dust cover blurb (dtype: `string`)
-  - `notes`: the number of review notes as an indicator wheter the the book is relevant; lumped to zero for *n*<3 notes (dtype: `int64`)
   - `publisher`: the publisher of the book  (dtype: `string`)
-  - `pub_place`: the place (city) where the books has been published (dtype: `string`)
-  - `pub_year`: the year the books has been published (dtype: `int64`)
-  - `is_novel`: boolean, whether the book is a novel (dtype: `bool`)
+  - `pub_place`: the place (city) where the books have been published; incorrect/inconsistent spellings have been corrected manually (dtype: `string`)
+  - `pub_year`: the year the books has been published (dtype: `uint16`)
+  - `media_type`: the type of media, i.e. *audio*, *print*, *videofilm* or unknown (dtype: `string`)
+  - `media_spec`: a specification of the media type; for books its binding like soft- or hardcover (dtype: `string`)
+  - `is_relevant`: boolean, whether the book is relevant (i.e. marked as *read a lot*, dtype: `bool`)
+  - `is_novel`: boolean, whether the book is a novel according to its title (dtype: `bool`)
+
+
+## Citation Information
+
+```
+
+@misc {schneider2024pearldive,
+	author       = { Schneider, Jo\~{a}o A G },
+	title        = { Pearl Diver },
+	year         = { 2024 },
+    month        = { May },
+	url          = { https://huggingface.co/datasets/JoaoSchneider/PearlDiver },
+	doi          = { 10.57967/hf/2245 },
+	publisher    = { Hugging Face },
+    note         = { Revision 786df49 }
+}
+
+```