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

Update doc read_network(): uniqueness of origin-destination data, invalidity...

Update doc read_network(): uniqueness of origin-destination data, invalidity of quotes in names, consistency of coordinates.
parent 6342467b
Pipeline #10609 passed with stage
in 19 seconds
Package: mapMCDA
Title: Produce an epidemiological risk map by weighting multiple risk
factors
Version: 0.4.15
Date: 2019-08-27
Version: 0.4.17
Date: 2020-04-11
Authors@R: c( person("Andrea", "Apolloni", email =
"andrea.apolloni@cirad.fr", role = c("ctb"), comment = "Animal
mobility algorithm"), person("Elena", "Arsevska", email =
......
#' Read and interpret network data
#'
#' 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.
#'
#' The file must be plain text with comma-separated columns and variable
#' names in the first line.
......@@ -20,7 +20,16 @@
#' }
#'
#' 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.
#'
#' @param x character. Path of csv file
#'
......
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