Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrolph authored Oct 3, 2023
1 parent f56ed80 commit a837ecd
Showing 1 changed file with 46 additions and 4 deletions.
50 changes: 46 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit a837ecd

Please sign in to comment.