Merge pull request #124 from dh-tech/feature/cleanup-examples

Reorganize examples and update readme / contents #121

Author: rlskoeser

examples/README.md

@@ -1,7 +1,13 @@
 # undate examples
 
-Example data and projects with use cases for uncertain date logic and 
-example code notebooks using undate.
-
-- [use cases](use-cases) - examples from projects or specific data with use cases for undate
-- [notebooks](notebooks) - code notebooks showing how undate can be used on a specific dataset or for a specific problem
+This folder contains code notebooks demonstrating how `undate` can be 
+used on a specific dataset, problem, or format, as well as example 
+data from projects with use cases for uncertain date logic.
+ 
+## Contents 
+ 
+- [EDTF support](edtf-support.ipynb) - demonstrate and validate supported portions of the Extended Date Time Format (EDTF) specification (jupyter notebook)
+- [ISMI](ismi) - Sample data from the Islamic Scientific Manuscript Initiative project
+- [Shakespeare and Company Project](shakespeare-and-company-project) - data, description of partial date implementation, and example notebook
+  - Events data from version 1.2 of Shakespeare and Company Project datasets
+  - [Partial date duration logic](shakespeare-and-company-project/shxco_partial_date_durations.ipynb) - compare `undate` partial date range duration logic with a previous implementation in the _Shakespeare and Company Project_ (jupyter notebook)

examples/notebooks/edtf-support.ipynb examples/edtf-support.ipynbexamples/notebooks/edtf-support.ipynb renamed to examples/edtf-support.ipynb

@@ -55,7 +55,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "id": "9c6b7379-b2a7-4ec1-afa5-2cd9832c8a5d",
    "metadata": {},
    "outputs": [],
@@ -92,7 +92,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "id": "923476ff-344a-4018-a02e-6e5f80ea76a8",
    "metadata": {},
    "outputs": [],
@@ -159,7 +159,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "id": "6ed422de-34a2-4324-b254-f62db00563f7",
    "metadata": {},
    "outputs": [],
@@ -212,7 +212,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "8d98a139-627b-40bd-b1c5-d0028e538a53",
    "metadata": {},
    "outputs": [],
@@ -255,7 +255,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 5,
    "id": "532470db-851e-4f91-9242-cd93d35054cf",
    "metadata": {},
    "outputs": [],
@@ -320,7 +320,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "id": "a5abd0e4-0b26-49b0-bf78-3e1fe6c046d8",
    "metadata": {},
    "outputs": [],
@@ -425,7 +425,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 7,
    "id": "e47f3fff-d35c-4c2e-9568-214763f6511a",
    "metadata": {},
    "outputs": [],
@@ -481,7 +481,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 8,
    "id": "39143c1f-932a-450c-9b2d-ffbe3e1416b0",
    "metadata": {},
    "outputs": [],
@@ -535,7 +535,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 9,
    "id": "95965f17-0bd5-446f-bc09-9503eaed68e2",
    "metadata": {},
    "outputs": [],
@@ -589,7 +589,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 10,
    "id": "c6c2d1a1-39f1-45eb-ac08-1de4fadbe842",
    "metadata": {},
    "outputs": [],
@@ -640,7 +640,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 11,
    "id": "f24fd31a-176a-40b5-bff4-d72b68f32a18",
    "metadata": {},
    "outputs": [],
@@ -688,7 +688,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 12,
    "id": "5910caab-eada-4715-b863-9bbbb15b9c5c",
    "metadata": {},
    "outputs": [],