Update README.md

updating dataset card with more detailed structure, data field, and updated citation info

README.md

@@ -17,109 +17,80 @@ size_categories:
 - n<1K
 ---
 
-<!--
-
-NOTE: Add more tags (your particular animal, type of model and use-case, etc.).
-
-As with your GitHub Project repo, it is important to choose an appropriate license for your dataset. The default license is [CC0](https://creativecommons.org/publicdomain/zero/1.0/) (public domain dedication, see [Dryad's explanation of why to use CC0](https://blog.datadryad.org/2023/05/30/good-data-practices-removing-barriers-to-data-reuse-with-cc0-licensing/)). Alongside the appropriate stakeholders (eg., your PI, co-authors), select a license that is [Open Source Initiative](https://opensource.org/licenses) (OSI) compliant.
-For more information on how to choose a license and why it matters, see [Choose A License](https://choosealicense.com) and [A Quick Guide to Software Licensing for the Scientist-Programmer](https://doi.org/10.1371/journal.pcbi.1002598) by A. Morin, et al.
-See the [Imageomics policy for licensing](https://docs.google.com/document/d/1SlITG-r7kdJB6C8f4FCJ9Z7o7ccwldZoSRJKjhRAWVA/edit#heading=h.c1sxg0wsiqru) for more information.
-
-See more options for the above information by clicking "edit dataset card" on your repo.
-
-Fill in as much information as you can at each location that says "More information needed".
--->
-
-<!--
-Image with caption:
-|![Figure #](https://huggingface.co/imageomics/<data-repo>/resolve/main/<filename>)|
-|:--|
-|**Figure #.** [Image of <>](https://huggingface.co/imageomics/<data-repo>/raw/main/<filename>) <caption description>.|
 -->
 
-<!--
-Notes on styling:
-
-To render LaTex in your README, wrap the code in `\\(` and `\\)`. Example: \\(\frac{1}{2}\\)
+# Dataset Card for wildwingdeployment
 
-Escape underscores ("_") with a "\". Example: image\_RGB
--->
+## Dataset Details
 
-# Dataset Card for wildwingdeployment
+This dataset contains video, telemetry, and autonomous navigation traces collected using the [WildWing](https://imageomics.github.io/wildwing/) unmanned aerial system (UAS) deployment at [The Wilds](https://www.thewilds.org/) in July 2024.
 
-<!-- Provide a quick summary of what the data is or can be used for. --> 
-Video, telemetry, and autonomous navigation traces from WildWing unmanned aerial system (UAS) deployment at The Wilds in July 2024.
 
-## Dataset Description
+### Dataset Description
 
 <!-- Provide the basic links for the dataset. -->
-<!--
-- **Homepage:** 
--->
-- **Repository:** https://github.com/Imageomics/wildwing
-<!--
-- **Paper:** 
-- **Leaderboard:**
-- -->
-  
-- **Point of Contact:** Jenna Kline; kline dot 377 @ osu dot edu
-
-### Dataset Summary
 
-<!-- Provide a longer summary of what this data is. -->
+- **Homepage:** https://imageomics.github.io/wildwing/
+- **Repository:** https://github.com/Imageomics/wildwing
+- **Paper:** [WildWing: An open-source, autonomous and affordable UAS for animal behaviour video monitoring](https://besjournals.onlinelibrary.wiley.com/doi/10.1111/2041-210X.70018)
 
-<!--This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).-->
 
-<!--
-### Supported Tasks and Leaderboards
-[More Information Needed]
--->
-### Languages
-english
+This dataset contains video frames collected at [The Wilds Conservation Center](https://www.thewilds.org/) in Ohio, USA, using drones. The Wilds is a 10,000 acre safari park and conservation center that is home to a variety of endangered species. The dataset includes one video of giraffes, one video Przewalski's horse, and three videos Grevy's Zebras. The dataset is intended for use in training and evaluating computer vision models for animal detection and classification from drone imagery. 
 
 ## Dataset Structure
 
-<!-- Provide format of the dataset, ex:
 
-```
-/dataset/
-    Folder_1/
-        File_1
-        File_2
-        ...
-        File_n
-    Folder_2/
-        File_1
-        File_2
-        ...
-        File_n
-    ...
-    Folder_N/
-        File_1
-        File_2
-        ...
-        File_n
-    metadata.csv
-```
-
--->
 ```
 /wildwingdeployment/
-    species_MMDDYY_HHMMSS/
+    giraffe_MMDDYY_HHMMSS/
         frames/
-            20.jpg
+            40.jpg
+            80.jpg
             ...
             n.jpg
         telemetry_log.csv
         video.MP4
     ...
-    species_MMDDYY_HHMMSS/
+    phorses_MMDDYY_HHMMSS/
         frames/
-            20.jpg
+            40.jpg
+            80.jpg
             ...
             n.jpg
         telemetry_log.csv
         video.MP4
+    zebras_MMDDYY_HHMMSS/
+        frames/
+            40.jpg
+            80.jpg
+            ...
+            n.jpg
+        telemetry_log.csv
+        video.MP4
+    zebras_MMDDYY_HHMMSS/
+        frames/
+            40.jpg
+            80.jpg
+            ...
+            n.jpg
+        telemetry_log.csv
+        video.MP4
+    zebras_MMDDYY_HHMMSS/
+        frames/
+            40.jpg
+            80.jpg
+            ...
+            n.jpg
+        telemetry_log.csv
+        video.MP4
+
+/telemetry/
+    giraffe_MMDDYY_HHMMSS_telemetry.csv
+    phorses_MMDDYY_HHMMSS_telemetry.csv
+    zebras_MMDDYY_HHMMSS_telemetry.csv
+    zebras_MMDDYY_HHMMSS_telemetry.csv
+    zebras_MMDDYY_HHMMSS_telemetry.csv
+
 ```    
         
 
@@ -128,23 +99,37 @@ english
 <!--
 Describe data files
 -->
-The data files contain telemetry logs, videos, and a frame folder containing jpgs. 
-- Telemetry log (CSV): location and status of the drone
-- Frame (JPG): Frame from video stream analyzed with YOLO to inform the commands sent to the drone
-- Video (MP4): video recorded by the drone during the mission
+The deployment data directory contains telemetry logs, video file, and frames produced for each session. The /frames/ subdirectory contain annotated video frames, downsampled every 40 frames. Each frame contains the YOLO-generated bounding box annotations which were used to inform the commands sent to the drone. The telemetry log contains the location of the drone and the commands sent to it at each frame. The MP4 file is the video recorded by the drone during the mission.
+
+The telemetry logs are also available in a separate directory, /telemetry/, which contains the detailed telemetry logs for each session. The telemetry logs contain the location of the drone during the mission (GPS, altitude), the commands sent to the drone (move_x, move_y, move_z in meters), and the frame number sensed at that timestamp.
 
 ### Data Fields
 
 <!--
 Describe the types of the data files or the columns in a CSV with metadata.
 -->
-Telemetry logs
-  - timestamp (YYYY-MM-DD HH:MM:SS)
-  - location of the drone during the mission (GPS, altitude)
-  - the commands sent to the drone (move_x, move_y, move_z in meters)
-  - the frame number sensed at that timestamp
-
-Note on altitude: The altitude recorded in feet (z column) is not accurate.
+#### /wildwingdeployment/ telemetry_log.csv
+| Field | Description | Details |
+|-------|-------------|---------|
+| timestamp | YYYY-MM-DD HH:MM:SS | Time of the drone mission data point |
+| location | GPS coordinates and altitude | **x**: latitude<br>**y**: longitude<br>**z**: altitude (not accurate) |
+| commands | Movement instructions in meters | **move_x**: x-axis movement in meters<br>**move_y**: y-axis movement in meters<br>**move_z**: z-axis movement in meters |
+| frame | Reference to captured image | See frames/40.jpg, frames/80.jpg, etc. |
+
+#### /telemetry/ species_MMDDYY_HHMMSS_telemetry.csv
+
+| Field | Description | Details |
+|-------|-------------|---------|
+| timestamp | YYYY-MM-DD HH:MM:SS | Time of the drone mission data point |
+| location | GPS coordinates and altitude | **x**: latitude<br>**y**: longitude<br>**z**: altitude (not accurate) |
+| commands | Movement instructions in meters | **move_x**: x-axis movement in meters<br>**move_y**: y-axis movement in meters<br>**move_z**: z-axis movement in meters |
+| frame | Reference to captured image | See frames/40.jpg, frames/80.jpg, etc. |
+| latitude | - | Direct latitude value |
+| longitude | - | Direct longitude value |
+| directory | - | Session in /wildwingdeployment/ the telemetry log belongs to |
+| distance | meters | Distance travelled from launch point |
+| bearing | degrees | Bearing from launch point |
+| speed | meters/second | Speed of the drone |
 
 <!--
 ### Data Splits
@@ -156,7 +141,7 @@ Give your train-test splits for benchmarking
 ## Dataset Creation
 
 ### Curation Rationale
-Data gathered to test the WildWing autonomous UAS system, designed to collect animal behavior video data.
+The data gathered to test the [WildWing autonomous UAS system](https://imageomics.github.io/wildwing/), designed to collect animal behavior video data. The goal is to evaluate and improve autonomous tracking and video collection of endangered species in the wild. 
 
 <!--
 ### Source Data
@@ -180,15 +165,16 @@ This dataset contains endangered species: Przewalski's horses and Grevy's zebras
 
 <!-- For instance, if your data includes people or endangered species. -->
 <!--
+
 ## Considerations for Using the Data
 ### Social Impact of Dataset
 [More Information Needed]
 
 ### Discussion of Biases
 [More Information Needed]
-
+ -->
 ### Other Known Limitations
-[More Information Needed]
+There was an instrument failure which caused the altitude recordings to be inaccurate. The altitude is not accurate, but the x and y coordinates are accurate. The telemetry logs contain the location of the drone during the mission (GPS, altitude), the commands sent to the drone (move_x, move_y, move_z in meters), and the frame number sensed at that timestamp.
 
 <!-- For instance, if your data exhibits a long-tailed distribution (and why). -->
 
@@ -202,21 +188,8 @@ Creative Commons Zero 1.0 universal
 
 ### Citation Information
 
-<!--
-If you want to include BibTex, replace "<>"s with your info 
--for an associated paper:
-```
-@article{<ref_code>,
-  title    = {<title>},
-  author   = {<author1 and author2>},
-  journal  = {<journal_name>},
-  year     =  <year>,
-  url      = {<DOI_URL>},
-  doi      = {<DOI>}
-}
-```
--just for data:
--->
+**Data**
+
 ```
 @misc{<Kline2024wildwingdeployment>,
   author = {Jenna Kline},
@@ -228,18 +201,21 @@ If you want to include BibTex, replace "<>"s with your info
 }
 ```
 
-<!---
-If the data is modified from another source, add the following. 
-
-Please be sure to also cite the original data source:
-<citation>
--->
-
+**Paper**
+```​
+@article{kline2025wildwing,
+  title={WildWing: An open-source, autonomous and affordable UAS for animal behaviour video monitoring},
+  author={Kline, Jenna and Zhong, Alison and Irizarry, Kevyn and Stewart, Charles V and Stewart, Christopher and Rubenstein, Daniel I and Berger-Wolf, Tanya},
+  journal={Methods in Ecology and Evolution},
+  year={2025},
+  doi={10.1111/2041-210X.70018},
+  publisher={Wiley Online Library}
+}
+```
 
 ### Contributions
 
-The [Imageomics Institute](https://imageomics.org) is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
-
-<!-- You may also want to credit the source of your data, i.e., if you went to a museum or nature preserve to collect it. -->
+The [Imageomics Institute](https://imageomics.org) is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). The National Science Foundation (NSF) supports [ICICLE: Intelligent CI with Computational Learning in the Environment](https://icicle.osu.edu/) under grant number [OAC-2112606](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2112606). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
 
-[The Wilds](https://www.thewilds.org/animals) is one of the largest conservation centers in the world, located in Cumberland, OH.
+## More Information 
+The data was gathered at [The Wilds Conservation Center](https://www.thewilds.org/) with permission from The Wilds Science Committee to take field observations and fly drones in the pastures.