README.Rmd 2.52 KB
Newer Older
Facundo Muñoz's avatar
Facundo Muñoz committed
1
2
3
4
---
output: github_document
---

Facundo Muñoz's avatar
Facundo Muñoz committed
5
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mapMCDA)](https://cran.r-project.org/package=mapMCDA)
6
7
[![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
8

Facundo Muñoz's avatar
Facundo Muñoz committed
9
# mapMCDA <img src="man/figures/logo.png" align="right" />
Facundo Muñoz's avatar
Facundo Muñoz committed
10
11
12
13
14
15
16
17
18

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
```
  
Facundo Muñoz's avatar
Facundo Muñoz committed
19

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

Facundo Muñoz's avatar
Facundo Muñoz committed
22
23
`mapMCDA` helps producing __risk maps__ by weighting __risk factors__ using
__expert knowledge__.
Facundo Muñoz's avatar
Facundo Muñoz committed
24

Facundo Muñoz's avatar
Facundo Muñoz committed
25
26
27
28
29
30
31
32
33
34
35
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.). 

In order to design a __stratified sampling__ or a __surveillance
campaign__, a preliminar risk map based on expert judgement is
required.

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

Facundo Muñoz's avatar
Facundo Muñoz committed
37
38
39
40
41
42
43
44
45
![](man/figures/plot-risk-unit-1.png)


The package include a Graphical User Interface (Shiny) that helps
in processing and weighting risk factors.

```{r eval = FALSE}
library(mapMCDA)
mapMCDA_app()
Facundo Muñoz's avatar
Facundo Muñoz committed
46
47
```

Facundo Muñoz's avatar
Facundo Muñoz committed
48
![](man/figures/interface.png)
Facundo Muñoz's avatar
Facundo Muñoz committed
49
50


Facundo Muñoz's avatar
Facundo Muñoz committed
51
## Installing the package
Facundo Muñoz's avatar
Facundo Muñoz committed
52

Facundo Muñoz's avatar
Facundo Muñoz committed
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
`mapMCDA` is on its way to CRAN. In the meanwhile, install from 
GitHub as follows.

<!-- 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 install-github, eval = FALSE}
if (!require("remotes")) {
  install.packages("remotes")
}
remotes::install_github("Cirad-ASTRE/mapMCDA")
```
Facundo Muñoz's avatar
Facundo Muñoz committed
68
69
70



Facundo Muñoz's avatar
Facundo Muñoz committed
71
<!-- # Resources -->
Facundo Muñoz's avatar
Facundo Muñoz committed
72

Facundo Muñoz's avatar
Facundo Muñoz committed
73
<!-- ## Vignettes -->
Facundo Muñoz's avatar
Facundo Muñoz committed
74

Facundo Muñoz's avatar
Facundo Muñoz committed
75
<!-- An overview and examples of *mapMCDA* are provided in the vignettes: -->
Facundo Muñoz's avatar
Facundo Muñoz committed
76

Facundo Muñoz's avatar
Facundo Muñoz committed
77
<!-- ... -->
Facundo Muñoz's avatar
Facundo Muñoz committed
78

Facundo Muñoz's avatar
Facundo Muñoz committed
79
<!-- ## Websites -->
Facundo Muñoz's avatar
Facundo Muñoz committed
80

Facundo Muñoz's avatar
Facundo Muñoz committed
81
<!-- The following websites are available: -->
Facundo Muñoz's avatar
Facundo Muñoz committed
82

Facundo Muñoz's avatar
Facundo Muñoz committed
83
<!-- ... -->
Facundo Muñoz's avatar
Facundo Muñoz committed
84
85
86

## Getting help online

Facundo Muñoz's avatar
Facundo Muñoz committed
87
88
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
89
90
91

Contributions are welcome via **pull requests**.

Facundo Muñoz's avatar
Facundo Muñoz committed
92
93
94
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.
Facundo Muñoz's avatar
Facundo Muñoz committed
95