Merge pull request #334 from tdwg/update_example

Document example dataset

_layouts/example.html

@@ -11,7 +11,7 @@
 {% assign media = site.data.media | where: 'deploymentID', deployment_id %}
 {% assign observations = site.data.observations | where: 'deploymentID', deployment_id %}
 
-<h2 id="{{ deployment_id }}">Deployment information</h2>
+<h2 id="deployment">Deployment</h2>
 
 <h3 id="location">Location</h3>
 <ul>
@@ -49,13 +49,14 @@ <h3 id="organizational">Organizational</h3>
   <li>deploymentComments: <code>{{ deployment.deploymentComments }}</code></li>
 </ul>
 
+<h2 id="events">Events</h2>
 {% assign event_ids = observations | map: 'eventID' | uniq %}
 {% for event_id in event_ids %}
   {% assign media_observations = observations | where: 'eventID', event_id | where: 'observationLevel', 'media' %}
   {% assign event_observations = observations | where: 'eventID', event_id | where: 'observationLevel', 'event' %}
   {% assign media_ids = media_observations | map: 'mediaID' | uniq %}
   {% comment %}The order of media_ids relies on the sorting in the observation table{% endcomment %}
-  <h2 id="{{ event_id }}">Event: {{ event_id }}</h2>
+  <h3 id="{{ event_id }}">Event {{ event_id }}</h3>
 
   <div id="carousel-{{ event_id }}" class="carousel slide carousel-fade mb-4" data-bs-ride="carousel" data-bs-keyboard="false" data-bs-interval="500">
     <div class="carousel-inner">
@@ -96,7 +97,7 @@ <h2 id="{{ event_id }}">Event: {{ event_id }}</h2>
     </button>
   </div>
 
-  <h4>Event-based observations</h4>
+  <h4 id="{{ event_id }}-event-observations">Event-based observations</h4>
   <table class="table table-sm font-monospace" style="font-size: 0.75em;">
     <colgroup>
       <col width="15%">
@@ -136,7 +137,7 @@ <h4>Event-based observations</h4>
     </tbody>
   </table>
 
-  <h4>Media-based observations</h4>
+  <h4 id="{{ event_id}}-media-observations">Media-based observations</h4>
   <table class="table table-sm font-monospace" style="font-size: 0.75em;">
     <colgroup>
       <col width="15%">

example/datapackage.json

@@ -275,7 +275,7 @@
   "relatedIdentifiers": [
     {
       "relationType": "IsDerivedFrom",
-      "relatedIdentifier": "https://doi.org/10.5281/zenodo.5590881",
+      "relatedIdentifier": "https://doi.org/10.15468/5tb6ze",
       "resourceTypeGeneral": "Dataset",
       "relatedIdentifierType": "DOI"
     },

pages/example.md

@@ -1,19 +1,45 @@
 ---
 title: Example dataset
 permalink: /example/
-toc: false
+toc: true
 ---
 
-The example dataset is included and versioned with Camtrap DP for testing purposes and to illustrate to format.
+The example dataset is derived from an existing camera trap study and aims to illustrate the Camtrap DP format. Since it is included and versioned with Camtrap DP, it can be used as a valid test dataset for each version.
 
-[Download example dataset](https://download-directory.github.io?url=https://github.com/tdwg/camtrap-dp/tree/main/example){:.btn .btn-primary target="_blank"}
-[See example dataset on GitHub](https://github.com/tdwg/camtrap-dp/tree/main/example){:.btn .btn-outline-primary}
+## Background
+
+The dataset is derived from a [camera trap study](https://lifemica.eu/research-innovaties/camera-tracking/) designed to detect invasive muskrat and coypu populations in Belgium, the Netherlands and Germany. The study was led by Emma Cartuyvels and coordinated by the [Research Institute for Nature and Forest (INBO)](https://inbo.be). Data were managed and annotated at event-level in [Agouti.eu](https://www.agouti.eu/). The full dataset is published to the [Global Biodiversity Information Facility (GBIF)](https://doi.org/10.15468/5tb6ze). The example dataset contains four deployments of the original dataset (all located in Belgium) and was expanded to include media-based observations in addition to event-based ones.
+
+## Download
+
+Camtrap DP version | Dataset download | Dataset on GitHub
+--- | --- | ---
+`1.0-rc.1` | [Download](https://download-directory.github.io?url=https://github.com/tdwg/camtrap-dp/tree/1.0-rc.1/example){:.btn .btn-sm .btn-primary target="_blank"} | [GitHub](https://github.com/tdwg/camtrap-dp/tree/1.0-rc.1/example){:.btn .btn-sm .btn-outline-primary}
 
 ## Preview
 
-Visualization of the deployments, media and observations:
+Preview of the deployments, media and observations:
 
 - [Deployment 1](../example/00a2c20d/)
 - [Deployment 2](../example/29b7d356/)
 - [Deployment 3](../example/62c200a9/)
 - [Deployment 4](../example/577b543a/)
+
+## Use cases
+
+The selected deployments covers a wide range of use cases:
+
+- [Blank](../example/29b7d356/#1d98da96)
+- [Unknown](../example/577b543a/#5fbf69a4)
+- [Vehicle](../example/62c200a9/#962dff14) (with hidden media files)
+- [Setup with human](../example/00a2c20d/#99880973) (with hidden media files)
+- [Timelapse image](../example/577b543a/#8f779513)
+- [AI-classified observation](../example/62c200a9/#4dcacd8f) with bounding boxes
+- [Animals of mixed species and sex](../example/00a2c20d/#79204343)
+- [Animals of mixed lifestage](../example/00a2c20d/#ea72c74f)
+- [Animal appearing and disappearing](../example/00a2c20d/#45abeadc) throughout the event
+- [Animals passing by](../example/29b7d356/#45ee3031) resulting in a higher count for the event than any single media file
+
+## Citation
+
+> Desmet P, Neukermans A, Van der beeck D, Cartuyvels E (2022). Sample from: MICA - Muskrat and coypu camera trap observations in Belgium, the Netherlands and Germany. Version 1.0. Research Institute for Nature and Forest (INBO). Dataset. <https://tdwg.github.io/camtrap-dp/example/>