This is just a template. Please remove, add or edit parts as you see fit.
## Installing the package
`mapMCDA` helps producing __risk maps__ by weighting __risk factors__ using
__expert knowledge__.
To install the current stable, CRAN version of the package, type:
```{r install, eval = FALSE}
install.packages("mapMCDA")
```
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.
To benefit from the latest features and bug fixes, install the development, *github* version of the package using:
```{r install2, eval = FALSE}
devtools::install_github("Cirad-ASTRE/mapMCDA")
The package include a Graphical User Interface (Shiny) that helps
in processing and weighting risk factors.
```{r eval = FALSE}
library(mapMCDA)
mapMCDA_app()
```
Note that this requires the package *devtools* installed.
# What does it do?
## Installing the package
The main features of the package include:
`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/geonetwork")
remotes::install_github("Cirad-ASTRE/mapMCDA")
```
# Resources
<!-- # Resources -->
## Vignettes
<!-- ## Vignettes -->
An overview and examples of *mapMCDA* are provided in the vignettes:
<!-- An overview and examples of *mapMCDA* are provided in the vignettes: -->
...
<!-- ... -->
## Websites
<!-- ## Websites -->
The following websites are available:
<!-- The following websites are available: -->
...
<!-- ... -->
## Getting help online
Bug reports and feature requests should be posted on *github* using the [*issue*](http://github.com/Cirad-ASTRE/mapMCDA/issues) system.
Bug reports and feature requests should be posted on *github* using
the [*issue*](http://github.com/Cirad-ASTRE/mapMCDA/issues) system.
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.
Please note that this project is released with a [Contributor Code of
Conduct](CONDUCT.md). By participating in this project you agree to
This is just a template. Please remove, add or edit parts as you see fit.
Installing the package
----------------------
To install the current stable, CRAN version of the package, type:
``` r
install.packages("mapMCDA")
```
To benefit from the latest features and bug fixes, install the development, *github* version of the package using:
``` r
devtools::install_github("Cirad-ASTRE/mapMCDA")
```
`mapMCDA` helps producing **risk maps** by weighting **risk factors** using **expert knowledge**.
Note that this requires the package *devtools* installed.
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.).
What does it do?
================
In order to design a **stratified sampling** or a **surveillance campaign**, a preliminar risk map based on expert judgement is required.
The main features of the package include:
This package (and method) provides a systematic and guided approach to build such maps.
Resources
=========
Vignettes
---------
The package include a Graphical User Interface (Shiny) that helps in processing and weighting risk factors.
An overview and examples of *mapMCDA* are provided in the vignettes:
``` r
library(mapMCDA)
mapMCDA_app()
```
...
Websites
--------
Installing the package
----------------------
The following websites are available:
`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
if(!require("remotes")){
install.packages("remotes")
}
remotes::install_github("Cirad-ASTRE/geonetwork")
remotes::install_github("Cirad-ASTRE/mapMCDA")
```
<!-- # Resources -->
<!-- ## Vignettes -->
<!-- An overview and examples of *mapMCDA* are provided in the vignettes: -->
.png){kind=link}
.png)
