Commit ca1a3ce7 authored by Facundo Muñoz's avatar Facundo Muñoz ®️
Browse files

Update README

parent 593aed9d
......@@ -6,50 +6,91 @@ output: github_document
[![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)
# Welcome to the *mapMCDA* package!
# mapMCDA
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
This is just a template. Please remove, add or edit parts as you see fit.
![](man/figures/mapMCDA_overview.png)
## 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")
![](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()
```
Note that this requires the package *devtools* installed.
![](man/figures/interface.png)
# 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
abide by its terms.
[![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)
Welcome to the *mapMCDA* package!
=================================
mapMCDA
=======
This is just a template. Please remove, add or edit parts as you see fit.
![](man/figures/mapMCDA_overview.png)
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
=========
![](man/figures/plot-risk-unit-1.png)
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()
```
...
![](man/figures/interface.png)
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: -->
<!-- ... -->
<!-- ## Websites -->
<!-- The following websites are available: -->
<!-- ... -->
Getting help online
-------------------
......
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:java="http://www.yworks.com/xml/yfiles-common/1.0/java" xmlns:sys="http://www.yworks.com/xml/yfiles-common/markup/primitives/2.0" xmlns:x="http://www.yworks.com/xml/yfiles-common/markup/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
<!--Created by yEd 3.17.2-->
<key attr.name="Description" attr.type="string" for="graph" id="d0"/>
<key for="port" id="d1" yfiles.type="portgraphics"/>
<key for="port" id="d2" yfiles.type="portgeometry"/>
<key for="port" id="d3" yfiles.type="portuserdata"/>
<key attr.name="url" attr.type="string" for="node" id="d4"/>
<key attr.name="description" attr.type="string" for="node" id="d5"/>
<key for="node" id="d6" yfiles.type="nodegraphics"/>
<key for="graphml" id="d7" yfiles.type="resources"/>
<key attr.name="url" attr.type="string" for="edge" id="d8"/>
<key attr.name="description" attr.type="string" for="edge" id="d9"/>
<key for="edge" id="d10" yfiles.type="edgegraphics"/>
<graph edgedefault="directed" id="G">
<data key="d0"/>
<node id="n0">
<data key="d5"/>
<data key="d6">
<y:GenericNode configuration="com.yworks.flowchart.start1">
<y:Geometry height="51.9375" width="88.939453125" x="0.0" y="-153.87549603174602"/>
<y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="45.408203125" x="21.765625" y="10.0">Risk
factors<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
<y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/>
</y:ModelParameter>
</y:NodeLabel>
</y:GenericNode>
</data>
</node>
<node id="n1">
<data key="d5"/>
<data key="d6">
<y:GenericNode configuration="com.yworks.flowchart.start1">
<y:Geometry height="51.9375" width="88.939453125" x="0.0" y="-71.93779761904761"/>
<y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="68.939453125" x="10.0" y="10.0">Expert
judgement<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
<y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/>
</y:ModelParameter>
</y:NodeLabel>
</y:GenericNode>
</data>
</node>
<node id="n2">
<data key="d5"/>
<data key="d6">
<y:GenericNode configuration="com.yworks.flowchart.process">
<y:Geometry height="51.9375" width="88.939453125" x="147.9239273313492" y="-112.90664682539682"/>
<y:Fill color2="#B7C9E3" hasColor="false" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="66.841796875" x="11.048828125" y="16.984375">mapMCDA<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
<y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/>
</y:ModelParameter>
</y:NodeLabel>
</y:GenericNode>
</data>
</node>
<node id="n3">
<data key="d5"/>
<data key="d6">
<y:GenericNode configuration="com.yworks.flowchart.terminator">
<y:Geometry height="51.9375" width="88.939453125" x="256.8633804563492" y="-112.90664682539682"/>
<y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="31.9375" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="30.66015625" x="29.1396484375" y="10.0">Risk
map<y:LabelModel>
<y:SmartNodeLabelModel distance="4.0"/>
</y:LabelModel>
<y:ModelParameter>
<y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/>
</y:ModelParameter>
</y:NodeLabel>
</y:GenericNode>
</data>
</node>
<edge id="e0" source="n0" target="n2">
<data key="d9"/>
<data key="d10">
<y:PolyLineEdge>
<y:Path sx="44.4697265625" sy="-0.0" tx="-44.4697265625" ty="-12.984375">
<y:Point x="104.43945312499999" y="-127.90674603174604"/>
<y:Point x="132.4239273313492" y="-99.92227182539682"/>
</y:Path>
<y:LineStyle color="#000000" type="line" width="1.0"/>
<y:Arrows source="none" target="standard"/>
<y:BendStyle smoothed="false"/>
</y:PolyLineEdge>
</data>
</edge>
<edge id="e1" source="n1" target="n2">
<data key="d9"/>
<data key="d10">
<y:PolyLineEdge>
<y:Path sx="44.4697265625" sy="-0.0" tx="-44.4697265625" ty="12.984375">
<y:Point x="104.439453125" y="-45.96904761904762"/>
<y:Point x="132.4239273313492" y="-73.95352182539682"/>
</y:Path>
<y:LineStyle color="#000000" type="line" width="1.0"/>
<y:Arrows source="none" target="standard"/>
<y:BendStyle smoothed="false"/>
</y:PolyLineEdge>
</data>
</edge>
<edge id="e2" source="n2" target="n3">
<data key="d9"/>
<data key="d10">
<y:PolyLineEdge>
<y:Path sx="44.4697265625" sy="-0.0" tx="-44.4697265625" ty="-0.0"/>
<y:LineStyle color="#000000" type="line" width="1.0"/>
<y:Arrows source="none" target="standard"/>
<y:BendStyle smoothed="false"/>
</y:PolyLineEdge>
</data>
</edge>
</graph>
<data key="d7">
<y:Resources/>
</data>
</graphml>
This diff is collapsed.
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