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

Update help pages.

parent db38429d
Package: mapMCDA
Title: Produce an epidemiological risk map by weighting multiple risk
factors
Version: 0.4.24
Version: 0.4.25
Date: 2020-04-12
Authors@R: c( person("Andrea", "Apolloni", email =
"andrea.apolloni@cirad.fr", role = c("ctb"), comment = "Animal
......@@ -31,7 +31,7 @@ Imports: classInt, deldir, geojsonio, geojsonlint, geonetwork, igraph,
rgdal, rgeos, rhandsontable, shiny, shinydashboard, shinyFiles,
sp, stringr, utils
Suggests: devtools, knitr, mapview, rmarkdown, roxygen2, testthat
RoxygenNote: 6.1.1
RoxygenNote: 7.1.0
URL: https://umr-astre.pages.mia.inra.fr/mapMCDA
BugReports: https://forgemia.inra.fr/umr-astre/mapMCDA/issues
VignetteBuilder: knitr
......@@ -4,8 +4,7 @@
\alias{distance_map}
\title{Compute a distance map to spatial features}
\usage{
distance_map(x, boundaries, res = resolution(boundaries, max_ncells =
100))
distance_map(x, boundaries, res = resolution(boundaries, max_ncells = 100))
}
\arguments{
\item{x}{Spatial* object with relevant spatial features.}
......
......@@ -3,7 +3,6 @@
\docType{package}
\name{mapMCDA}
\alias{mapMCDA}
\alias{mapMCDA-package}
\title{mapMCDA}
\description{
Produce an epidemiological risk map by weighting multiple risk factors
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/network.R
\docType{methods}
\name{rasterize_geonetwork}
\alias{rasterize_geonetwork}
\alias{rasterize,geonetwork,Raster-method}
......@@ -9,8 +8,7 @@
\usage{
\S4method{rasterize}{geonetwork,Raster}(x, y, field = "importance", ...)
\S4method{rasterize}{geonetwork,SpatialPolygons}(x, y,
res = resolution(y, max_ncells = 100), ...)
\S4method{rasterize}{geonetwork,SpatialPolygons}(x, y, res = resolution(y, max_ncells = 100), ...)
}
\arguments{
\item{x}{a geographic network (a geonetwork object with node attributes
......
......@@ -10,11 +10,11 @@ read_network(x)
\item{x}{character. Path of csv file}
}
\value{
object of class \code{igraph}
Object of classes \code{geonetwork} and \code{igraph}.
}
\description{
Read a csv file with a specific format (see Details) and intepret
it as network directed data with possibly weighted edges.
it as network origin-destination data with possibly weighted edges.
}
\details{
The file must be plain text with comma-separated columns and variable
......@@ -34,7 +34,16 @@ same types as follows:
}
Variable names can be different. If strings contain spaces they must
be quoted.
be quoted. For this reason, \strong{quotes cannot be part of node names}.
E.g. the name \emph{Abangminko'O} is invalid and will rise an error.
\strong{Each origin-destination must be specified only once}. If you
have multple animal shipments between the same origin and destination
spread in several lines, you need to aggregate them into a single line.
Make sure \strong{coordinates are consistent}. I.e. All nodes must
have the same coordinates in all the lines where it appears as
either source or destination.
}
\examples{
d <- data.frame(from = "A", to = "B", fx = 0, fy = 0, tx = 1, ty = 1)
......
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