From a837ecd2e15bd6d52f3993aa208859af66b0e50a Mon Sep 17 00:00:00 2001 From: Simon Rolph Date: Tue, 3 Oct 2023 11:26:25 +0100 Subject: [PATCH] Update README.md --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a9b96b0..549839d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,49 @@ -# "Easily missed" +# Easily Missed - Find Data Gaps in iNaturalist -Missing local records of regionally common species. +![image](https://github.com/simonrolph/easily_missed/assets/17750766/c001c077-f719-4972-a2dc-ec5e208ef44d) -A webpage that presents some data from iNaturalist to highlight missing records in your immediate locality based on species that have been recorded in the surrounding region. +## Overview -A personal project. +Easily Missed is a web application designed to help iNaturalist observers identify gaps in species records within their local area. By suggesting which species should be observed and reported on iNaturalist, it assists in building a more complete picture of local wildlife. + +## Getting Started + +- Visit [Easily Missed](https://simonrolph.github.io/easily_missed/) to access the web app. +- To understand how to use the app, click on the "Getting started" link on the page. + +## How It Works + +Easily Missed creates a list of species recorded within your region, typically within 5 kilometers of your location. It helps prioritize species to fill data gaps by identifying species that haven't been recorded in your immediate vicinity, usually within 1 kilometer. Here's how it works: + +1. The tool builds a list of species recorded in your region. +2. It prioritizes species not recorded in your local area, effectively filling data gaps. +3. By doing this, you improve your area's "doughnut score," representing the percentage of species recorded locally compared to the wider region. + +Advanced users can customize the radius of the doughnut and the doughnut hole. Additionally, you can provide parameters in the tool's URL to affect the data retrieved from iNaturalist. + +## Screenshots + +### Map and headline numbers + +![image](https://github.com/simonrolph/easily_missed/assets/17750766/c409f593-5e91-4c99-9e4b-fda724b92cb2) + +### Species lists + +![image](https://github.com/simonrolph/easily_missed/assets/17750766/213f0459-e0f0-412c-aca1-4e88067a8112) + +## Advanced Options + +You can customize the following options: + +- Inner circle radius (km): Adjust the radius of the inner circle. +- Outer circle radius (km): Modify the radius of the outer circle. +- Latitude and Longitude: Manually set the location. + +## Providing Feedback + +Easily Missed is a work in progress, and your feedback is valuable. Please provide feedback on the [iNaturalist forum](https://forum.inaturalist.org/t/a-tool-to-help-you-fill-local-data-gaps-easily-missed/37575/) or submit issues or feature requests on [GitHub](https://github.com/simonrolph/easily_missed/issues). + +## Credits + +- **Simon Rolph**: Developer of Easily Missed. +- Find the source code on [GitHub](https://github.com/simonrolph/easily_missed).