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

Improve package doc.

parent 165af09b
Pipeline #44709 failed with stages
in 1 minute and 7 seconds
Package: mapMCDA
Title: Produce an epidemiological risk map by weighting multiple risk
factors
Version: 0.4.59
Date: 2021-10-23
Version: 0.4.60
Date: 2021-11-19
Authors@R: c( person("Andrea", "Apolloni", email =
"andrea.apolloni@cirad.fr", role = c("ctb"), comment = "Animal
mobility algorithm"), person("Elena", "Arsevska", email =
......
#' mapMCDA
#'
#' Produce an epidemiological risk map by weighting multiple risk factors
#' Produce an epidemiological risk map by weighting multiple risk factors.
#'
#' 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.
#'
#' mapMCDA provides a Shiny graphical user interface launched with
#' \code{mapMCDA_app()}.
#' It can also be used from command line and scripted.
#' You can see an example (in french) in the vignette
#' \href{https://umr-astre.pages.mia.inra.fr/mapMCDA/articles/mapMCDA.html}{Overview}.
#'
#'
#' @references https://umr-astre.pages.mia.inra.fr/mapMCDA/
#'
#' @name mapMCDA
#' @import methods
......
......@@ -5,5 +5,22 @@
\alias{mapMCDA}
\title{mapMCDA}
\description{
Produce an epidemiological risk map by weighting multiple risk factors
Produce an epidemiological risk map by weighting multiple risk factors.
}
\details{
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.
mapMCDA provides a Shiny graphical user interface launched with
\code{mapMCDA_app()}.
It can also be used from command line and scripted.
You can see an example (in french) in the vignette
\href{https://umr-astre.pages.mia.inra.fr/mapMCDA/articles/mapMCDA.html}{Overview}.
}
\references{
https://umr-astre.pages.mia.inra.fr/mapMCDA/
}
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