Commit b5589a78 authored by floriandeboissieu's avatar floriandeboissieu

update README and website toc

parent 1d4f855b
......@@ -2,24 +2,26 @@
**[https://jbferet.github.io/biodivMapR](https://jbferet.github.io/biodivMapR/index.html)**
![licence](https://img.shields.io/badge/Licence-GPL--3-blue.svg)
![licence](https://img.shields.io/badge/Licence-GPL--3-blue.svg)
[![Build Status](https://travis-ci.org/jbferet/biodivMapR.png?branch=master)](https://travis-ci.org/jbferet/biodivMapR)
# 1 Install
After installing packages `devtools`, package `biodivMapR` can then be installed with the following command line in R session:
After installing package `devtools`, package `biodivMapR` can be installed with the following command line in R session:
```
devtools::install_github('jbferet/biodivMapR')
```
# 2 Tutorial
A tutorial vignette showing the main steps of the processing can be visualised with the following command line:
```
rstudioapi::viewer(system.file('doc', 'tutorial.html', package='biodivMapR'))
```
or for non Rstudio session:
```
vignette('tutorial', package='biodivMapR')
```
A tutorial vignette is available [here](https://jbferet.github.io/biodivMapR/articles/biodivMapR.html).
The corresponding script is available in file `examples/tutorial.R`.
# 3 Citation
If you use **biodivMapR**, please cite the following references:
Féret, J.-B., de Boissieu, F., 2019. biodivMapR: an R package for α‐ and β‐diversity mapping using remotely‐sensed images. Methods Ecol. Evol. 00:1-7. https://doi.org/10.1111/2041-210X.13310
Féret, J.-B., Asner, G.P., 2014. Mapping tropical forest canopy diversity using high-fidelity imaging spectroscopy. Ecol. Appl. 24, 1289–1296. https://doi.org/10.1890/13-1824.1
destination: docs
toc:
depth: 1
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment