README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# <span style="color:#68AF5D">diveRpine</span> <img src="man/figures/logo.png" align="right" width="240"/>

## <span style="color:#68AF5D">**diveR**</span>sification of <span style="color:#68AF5D">**pine**</span> plantations in Mediterranean mountains

<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-blue.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3697818.svg)](https://doi.org/10.5281/zenodo.3697818)
<!-- badges: end -->

diveRpine is an interactive **R** tool which simulates the way in which species diversity in pine plantations varies depending on the landscape configuration, the internal structure of the plantation (*e.g.* past land uses, tree density), and the composition of the dispersion vectors (*e.g.* birds, mammals).

<br>
The aim of the application is to develop a decision-support tool that simulates the dynamics of forest ecological processes. 
<br>
The application projects the most likely ecological succession in each stand based on the ecological context, and visualizes the relative importance of the different ecological mechanisms involved in the process. The resulting simulations help the manager to identify forest stands that most need intervention (active restoration), compared to other stands where intervention is unneeded (passive restoration), depending on the ecosystem services that the manager wishes to maximize. It also allows the user to visualize some of the complex ecological processes that underlie the diversification of pine plantations in Mediterranean mountain areas.
<br>
This tool uses information published in scientific journals in a synthetic and straightforward way, enabling the manager to visualize different scenarios and perform simulations based on solid field data interpreted in scientific contexts.

## Installation
diveRpine was built in [R](https://www.r-project.org), an open source programming language using the [Shiny package](https://shiny.rstudio.com), a web application framework for R. 

You can download the development version of diveRpine from [GitHub](https://github.com/ajpelu/diveRpine) with:

``` r
# install.packages("devtools")
devtools::install_github("ajpelu/diveRpine")
```

## How to run diveRpine

The recommended option to use the application is to download the package and run it locally. You can also use a running example [here](http://vlab.iecolab.es/ajpelu/diveRpine_app/). 

### Locally 

1. The use of Rstudio is recommended 

2. Download and install the `diveRpine` pkg using: 
``` r
# install.packages("devtools")
devtools::install_github("ajpelu/diveRpine")
```

3. Run the app: 
```r
library("diveRpine")
run_diveRpine()
```

All required code can be found in this [github repository](https://github.com/ajpelu/diveRpine).