Commit 686ff1f0 authored by Florian de Boissieu's avatar Florian de Boissieu
Browse files

update README and DESCRIPTION

parent c016a605
Package: DiversityMappR
Title: DiversityMappR: an R package for α- and β-diversity mapping using remotely-sensed images
Version: 0.0.0.9000
Authors@R:
person(given = "Jean-Baptiste",
family = "Feret",
role = c("aut", "cre"),
email = "jb.feret@teledetection.fr")
Authors@R: c( person("Jean-Baptiste", "Feret", email = "jb.feret@teledetection.fr", role = c("aut", "cre")),
person("Florian", "de Boissieu", email = "florian.deboissieu@irstea.fr", role = c("ctb"), comment = "clean code, format as package")
Description: this packages allows processing image data based on the method described in the following publication:
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
It expects an image file as input, with a specific data format.
......@@ -14,18 +12,19 @@ License: What license it uses
Encoding: UTF-8
LazyData: true
Imports:
R.utils,
matlab,
snow,
future.apply,
matrixStats,
fields,
ecodist,
zip,
vegan,
dissUtils,
ecodist,
fields,
future,
future.apply,
labdsv,
matlab,
matrixStats,
raster,
rgdal,
tools
R.utils,
snow,
tools,
vegan,
zip
RoxygenNote: 6.1.1
# DiversityMappR: an R package for α- and β-diversity mapping using remotely-sensed images
# 1 Install
After installing packages devtools and getPass, `DiversityMappR` can then be installed with the folloqing command line in R session, where `uname` is your gitlab.irstea.fr username:
```
devtools::install_git('https://gitlab.irstea.fr/jean-baptiste.feret/diversitymappr.git',
credentials = git2r::cred_user_pass("uname", getPass::getPass()))
```
1- link raw data included in data-raw, or put it in a directory publicly available where the package will be proposed.
2- hide all functions except:
......@@ -19,4 +28,4 @@
5- put the binary package ready to be installed in a directory publicly available where the data is stored as well.
6- replace hard-coded instructions (e.g. Lib_CheckConvertData.R line 110 to get access to the HDR templates)
\ No newline at end of file
6- replace hard-coded instructions (e.g. Lib_CheckConvertData.R line 110 to get access to the HDR templates)
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