README.Rmd 2.86 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
<!-- badges: start -->
Facundo Muñoz's avatar
Facundo Muñoz committed
6
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mapMCDA)](https://cran.r-project.org/package=mapMCDA)
7
[![Build status](https://forgemia.inra.fr/umr-astre/mapMCDA/badges/master/pipeline.svg)](https://forgemia.inra.fr/umr-astre/mapMCDA/pipelines)
8
[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/5p751lpceeiy18kp?svg=true)](https://ci.appveyor.com/project/famuvie/mapmcda)
Facundo Muñoz's avatar
Facundo Muñoz committed
9
<!-- badges: end -->
Facundo Muñoz's avatar
Facundo Muñoz committed
10

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

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

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

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

Facundo Muñoz's avatar
Facundo Muñoz committed
27
28
29
30
31
32
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
33
campaign__, a preliminary risk map based on expert judgement is
Facundo Muñoz's avatar
Facundo Muñoz committed
34
35
36
37
required.

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

Facundo Muñoz's avatar
Facundo Muñoz committed
39
40
41
42
43
44
45
46
47
![](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
48
49
```

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


Facundo Muñoz's avatar
Facundo Muñoz committed
53
## Installing the package
Facundo Muñoz's avatar
Facundo Muñoz committed
54

Facundo Muñoz's avatar
Facundo Muñoz committed
55
`mapMCDA` is on its way to CRAN. In the meanwhile, install from 
56
our r-universe as follows
Facundo Muñoz's avatar
Facundo Muñoz committed
57
58
59
60
61
62

<!-- To install the current stable, CRAN version of the package, type: -->
<!-- ```{r install, eval = FALSE} -->
<!-- install.packages("mapMCDA") -->
<!-- ``` -->

Facundo Muñoz's avatar
Facundo Muñoz committed
63
<!-- To benefit from the latest features and bug fixes, install the development, version of the package using: -->
64
65

<!--
Facundo Muñoz's avatar
Facundo Muñoz committed
66
```{r install-gitlab, eval = FALSE}
Facundo Muñoz's avatar
Facundo Muñoz committed
67
68
69
if (!require("remotes")) {
  install.packages("remotes")
}
Facundo Muñoz's avatar
Facundo Muñoz committed
70
remotes::install_gitlab("umr-astre/mapMCDA", host = "forgemia.inra.fr")
Facundo Muñoz's avatar
Facundo Muñoz committed
71
```
72
73
74
75
76
-->

```{r install-r-universe, eval = FALSE}
install.packages("mapMCDA", repos = "https://cirad-astre.r-universe.dev")
```
Facundo Muñoz's avatar
Facundo Muñoz committed
77
78
79



Facundo Muñoz's avatar
Facundo Muñoz committed
80
<!-- # Resources -->
Facundo Muñoz's avatar
Facundo Muñoz committed
81

Facundo Muñoz's avatar
Facundo Muñoz committed
82
<!-- ## Vignettes -->
Facundo Muñoz's avatar
Facundo Muñoz committed
83

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

Facundo Muñoz's avatar
Facundo Muñoz committed
86
<!-- ... -->
Facundo Muñoz's avatar
Facundo Muñoz committed
87

Facundo Muñoz's avatar
Facundo Muñoz committed
88
<!-- ## Websites -->
Facundo Muñoz's avatar
Facundo Muñoz committed
89

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

Facundo Muñoz's avatar
Facundo Muñoz committed
92
<!-- ... -->
Facundo Muñoz's avatar
Facundo Muñoz committed
93
94
95

## Getting help online

Facundo Muñoz's avatar
Facundo Muñoz committed
96
97
Bug reports and feature requests should be posted on *GitLab* using
the [*issue*](http://forgemia.inra.fr/umr-astre/mapMCDA/issues) system.
Facundo Muñoz's avatar
Facundo Muñoz committed
98

99
100
101
102
For support, reach out in the 
[mapMCDA mailing list](https://listes.cirad.fr/sympa/info/mapmcda).
Archives are of public access.

Facundo Muñoz's avatar
Facundo Muñoz committed
103
104
Contributions are welcome via **pull requests**.

Facundo Muñoz's avatar
Facundo Muñoz committed
105
106
107
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
108