README.md 2.45 KB
Newer Older
Facundo Muñoz's avatar
Facundo Muñoz committed
1

2
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/mapMCDA)](https://cran.r-project.org/package=mapMCDA) [![Travis Build Status](https://travis-ci.org/Cirad-ASTRE/mapMCDA.svg?branch=master)](https://travis-ci.org/Cirad-ASTRE/mapMCDA) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/nuo6t1hddibxxusd?svg=true)](https://ci.appveyor.com/project/famuvie/mapmcda)
Facundo Muñoz's avatar
Facundo Muñoz committed
3

Facundo Muñoz's avatar
Facundo Muñoz committed
4
5
mapMCDA <img src="man/figures/logo.png" align="right" />
========================================================
Facundo Muñoz's avatar
Facundo Muñoz committed
6

Facundo Muñoz's avatar
Facundo Muñoz committed
7
![](man/figures/mapMCDA_overview.png)
Facundo Muñoz's avatar
Facundo Muñoz committed
8

Facundo Muñoz's avatar
Facundo Muñoz committed
9
`mapMCDA` helps producing **risk maps** by weighting **risk factors** using **expert knowledge**.
Facundo Muñoz's avatar
Facundo Muñoz committed
10

Facundo Muñoz's avatar
Facundo Muñoz committed
11
The typical use case is the lack of (reliable) data about the epidemics of a disease, but available information about well known **risk factors** (e.g. animal density, proximity to border, proximity to water courses, etc.).
Facundo Muñoz's avatar
Facundo Muñoz committed
12

Facundo Muñoz's avatar
Facundo Muñoz committed
13
In order to design a **stratified sampling** or a **surveillance campaign**, a preliminar risk map based on expert judgement is required.
Facundo Muñoz's avatar
Facundo Muñoz committed
14

Facundo Muñoz's avatar
Facundo Muñoz committed
15
This package (and method) provides a systematic and guided approach to build such maps.
Facundo Muñoz's avatar
Facundo Muñoz committed
16

Facundo Muñoz's avatar
Facundo Muñoz committed
17
![](man/figures/plot-risk-unit-1.png)
Facundo Muñoz's avatar
Facundo Muñoz committed
18

Facundo Muñoz's avatar
Facundo Muñoz committed
19
The package include a Graphical User Interface (Shiny) that helps in processing and weighting risk factors.
Facundo Muñoz's avatar
Facundo Muñoz committed
20

Facundo Muñoz's avatar
Facundo Muñoz committed
21
22
23
24
``` r
library(mapMCDA)
mapMCDA_app()
```
Facundo Muñoz's avatar
Facundo Muñoz committed
25

Facundo Muñoz's avatar
Facundo Muñoz committed
26
![](man/figures/interface.png)
Facundo Muñoz's avatar
Facundo Muñoz committed
27

Facundo Muñoz's avatar
Facundo Muñoz committed
28
29
Installing the package
----------------------
Facundo Muñoz's avatar
Facundo Muñoz committed
30

Facundo Muñoz's avatar
Facundo Muñoz committed
31
`mapMCDA` is on its way to CRAN. In the meanwhile, install from GitHub as follows.
Facundo Muñoz's avatar
Facundo Muñoz committed
32

Facundo Muñoz's avatar
Facundo Muñoz committed
33
34
35
36
37
38
39
40
41
42
43
44
<!-- To install the current stable, CRAN version of the package, type: -->
<!-- ```{r install, eval = FALSE} -->
<!-- install.packages("mapMCDA") -->
<!-- ``` -->
<!-- To benefit from the latest features and bug fixes, install the development, *github* version of the package using: -->
``` r
if (!require("remotes")) {
  install.packages("remotes")
}
remotes::install_github("Cirad-ASTRE/geonetwork")
remotes::install_github("Cirad-ASTRE/mapMCDA")
```
Facundo Muñoz's avatar
Facundo Muñoz committed
45

Facundo Muñoz's avatar
Facundo Muñoz committed
46
47
48
49
50
51
52
<!-- # Resources -->
<!-- ## Vignettes -->
<!-- An overview and examples of *mapMCDA* are provided in the vignettes: -->
<!-- ... -->
<!-- ## Websites -->
<!-- The following websites are available: -->
<!-- ... -->
Facundo Muñoz's avatar
Facundo Muñoz committed
53
54
Getting help online
-------------------
Facundo Muñoz's avatar
Facundo Muñoz committed
55

Facundo Muñoz's avatar
Facundo Muñoz committed
56
Bug reports and feature requests should be posted on *github* using the [*issue*](http://github.com/Cirad-ASTRE/mapMCDA/issues) system.
Facundo Muñoz's avatar
Facundo Muñoz committed
57
58
59
60

Contributions are welcome via **pull requests**.

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.