Skip to content

Commit

Permalink
Update README badges (#128)
Browse files Browse the repository at this point in the history
* update badges and news
  • Loading branch information
goergen95 authored Jan 14, 2023
1 parent 253049c commit c995c04
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 23 deletions.
7 changes: 5 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
- GFW resources are now updated to use the latest version allowing analysis for
the additional year of 2021 (#123, @fBedecarrats)

- GFW indicators now accecpt numeric `min_size` argument allowing to specify
fractional covers (#110)

- fire indicators now allow the simultaneous calculation of indicators based on
MODIS and VIIRS. Before users had to chose between one of the instruments for
each analysis
each analysis (#126)

## Bug fixes
- case when one or multiple assets return NA instead of a tibble is now properly
Expand All @@ -24,7 +27,7 @@ tested and handled (#101)

## Internal
- `.make_global_grid()` now specifies the CRS when constructing the bounding box
and returns the grid in the specified CRS instead of Lat/Lon
and returns the grid in the specified CRS instead of Lat/Lon (#113)

- `.calc_active_fire_properties` now uses st_coordinates to retrieve locations
of fires (#119, @DavisVaughan)
Expand Down
60 changes: 42 additions & 18 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,20 +1,41 @@
---
output: github_document
---

<!-- badges: start -->

[![R-CMD-check](https://github.com/mapme-initiative/mapme.biodiversity/workflows/R-CMD-check/badge.svg)](https://github.com/mapme-initiative/mapme.biodiversity/actions)
[![Coverage Status](https://img.shields.io/codecov/c/github/mapme-initiative/mapme.biodiversity/master.svg)](https://codecov.io/github/mapme-initiative/mapme.biodiversity?branch=master)
[![CRAN status](https://www.r-pkg.org/badges/version/mapme.biodiversity)](https://CRAN.R-project.org/package=mapme.biodiversity)
[![CRAN status](https://badges.cranchecks.info/summary/mapme.biodiversity.svg)](https://cran.r-project.org/web/checks/check_results_mapme.biodiversity.html)
[![CRAN version](https://www.r-pkg.org/badges/version/mapme.biodiversity)](https://CRAN.R-project.org/package=mapme.biodiversity)
[![License](https://img.shields.io/badge/License-GPL (>=3)-brightgreen.svg?style=flat)](https://choosealicense.com/licenses/gpl-3.0/)

<!-- badges: end -->

# mapme.biodiversity <img src="man/figures/logo.png" align="right" height="110"/>

## About

Biodiversity areas, especially primary forests, provide multiple ecosystem services for the local population and the planet as a whole. The rapid expansion of human land use into natural ecosystems and the impacts of the global climate crisis put natural ecosystems and the global biodiversity under threat.

The mapme.biodiversity package helps to analyse a number of biodiversity related indicators and biodiversity threats based on freely available geodata-sources such as the Global Forest Watch. It supports computational efficient routines and heavy parallelization in cloud-infrastructures such as AWS or AZURE using in the statistical programming language R. The package allows for the analysis of global biodiversity portfolios with a thousand or millions of AOIs which is normally only possible on dedicated platforms such as the Google Earth Engine. It provides the possibility to e.g. analyse the World Database of Protected Areas (WDPA) for a number of relevant indicators. The primary use case of this package is to support scientific analysis and data science for individuals and organizations who seek to preserve the planet biodiversity. It's development is funded by the German Development Bank KfW.

Biodiversity areas, especially primary forests, provide multiple
ecosystem services for the local population and the planet as a whole.
The rapid expansion of human land use into natural ecosystems and the
impacts of the global climate crisis put natural ecosystems and the
global biodiversity under threat.

The mapme.biodiversity package helps to analyse a number of biodiversity
related indicators and biodiversity threats based on freely available
geodata-sources such as the Global Forest Watch. It supports
computational efficient routines and heavy parallelization in
cloud-infrastructures such as AWS or AZURE using in the statistical
programming language R. The package allows for the analysis of global
biodiversity portfolios with a thousand or millions of AOIs which is
normally only possible on dedicated platforms such as the Google Earth
Engine. It provides the possibility to e.g. analyse the World Database
of Protected Areas (WDPA) for a number of relevant indicators. The
primary use case of this package is to support scientific analysis and
data science for individuals and organizations who seek to preserve the
planet biodiversity. It's development is funded by the German
Development Bank KfW.

## Installation

Expand All @@ -32,10 +53,11 @@ remotes::install_github("https://github.com/mapme-initiative/mapme.biodiversity"

## Usage example

`{mapme.biodiversity}` works by constructing a portfolio from an sf object.
Specific raster and vector resource matching the spatio-temporal extent of the
portfolio are made available locally. Once all required resources are available,
indicators can be calculated individually for each asset in the portfolio.
`{mapme.biodiversity}` works by constructing a portfolio from an sf
object. Specific raster and vector resource matching the spatio-temporal
extent of the portfolio are made available locally. Once all required
resources are available, indicators can be calculated individually for
each asset in the portfolio.

To list all available resources and indicators run:

Expand All @@ -50,14 +72,15 @@ cat(sprintf("Supported resources:\n- %s\n\nSupported indicators:\n- %s",
paste(indicators, collapse = "\n- ")))
```

Once you have decided on an indicator you are interested in, you can initialize
a biodiversity portfolio by using an sf-object that only contains geometries of
type `POLYGON` via the `init_portfolio()` function call. This will set some
important information that is needed further down the processing
chain. We can then request the download of a resource that is required to
calculate specific indicators. Once the indicator has been calculated for
individually for all assets in a portfolio, the data is returned as a nested
list column to the original object.
Once you have decided on an indicator you are interested in, you can
initialize a biodiversity portfolio by using an sf-object that only
contains geometries of type `POLYGON` via the `init_portfolio()`
function call. This will set some important information that is needed
further down the processing chain. We can then request the download of a
resource that is required to calculate specific indicators. Once the
indicator has been calculated for individually for all assets in a
portfolio, the data is returned as a nested list column to the original
object.

```{r calculation}
(system.file("extdata", "sierra_de_neiba_478140_2.gpkg", package = "mapme.biodiversity") %>%
Expand All @@ -78,5 +101,6 @@ list column to the original object.
tidyr::unnest(treecover_area_and_emissions))
```

Head over to the [online documentation](https://mapme-initiative.github.io/mapme.biodiversity/index.html)
Head over to the [online
documentation](https://mapme-initiative.github.io/mapme.biodiversity/index.html)
find more detailed information about the package.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
[![Coverage
Status](https://img.shields.io/codecov/c/github/mapme-initiative/mapme.biodiversity/master.svg)](https://codecov.io/github/mapme-initiative/mapme.biodiversity?branch=master)
[![CRAN
status](https://www.r-pkg.org/badges/version/mapme.biodiversity)](https://CRAN.R-project.org/package=mapme.biodiversity)
status](https://badges.cranchecks.info/summary/mapme.biodiversity.svg)](https://cran.r-project.org/web/checks/check_results_mapme.biodiversity.html)
[![CRAN
version](https://www.r-pkg.org/badges/version/mapme.biodiversity)](https://CRAN.R-project.org/package=mapme.biodiversity)
[![License](https://img.shields.io/badge/License-GPL%20(%3E=3)-brightgreen.svg?style=flat)](https://choosealicense.com/licenses/gpl-3.0/)

<!-- badges: end -->

# mapme.biodiversity <img src="man/figures/logo.png" align="right" height="110"/>
Expand All @@ -14,7 +18,7 @@ status](https://www.r-pkg.org/badges/version/mapme.biodiversity)](https://CRAN.R

Biodiversity areas, especially primary forests, provide multiple
ecosystem services for the local population and the planet as a whole.
The rapid expansion of human landuse into natural ecosystems and the
The rapid expansion of human land use into natural ecosystems and the
impacts of the global climate crisis put natural ecosystems and the
global biodiversity under threat.

Expand Down Expand Up @@ -62,7 +66,7 @@ library(mapme.biodiversity)
library(sf)
```

## Linking to GEOS 3.10.2, GDAL 3.4.1, PROJ 8.2.1; sf_use_s2() is TRUE
## Linking to GEOS 3.11.1, GDAL 3.6.1, PROJ 9.1.1; sf_use_s2() is TRUE

``` r
resources <- names(available_resources())
Expand Down

0 comments on commit c995c04

Please sign in to comment.