Commit d53073e9 authored by Nicolas Lambert's avatar Nicolas Lambert
Browse files

doc

parent 2e6513c7
#' Title
#'
#' @param x
#' @param xid
#' @param df
#' @param dfid
#' @param dfvar
#' @param size
#' @param type
#' @param decreasing
#' @param add
#' @param lwd
#' @param col
#' @param border
#' @param k
#' @param df2
#' @param df2id
#' @param df2var
#' @param k2
#' @param x an sf object (polygon or multipolygons).
#' @param xid name of the identifier variable in x, default is "id".
#' @param df name of the numeric field in df to plot flows.
#' @param dfid name of the two identifier variables in df, default is c("i","j").
#' @param dfvar name of the numeric variable to plot flows, default is "fij".
#' @param size way of calculating the size of the flows, "thickness" ou "area, default is "thickness".
#' @param type type of flows, "rect" (for rectangles) or "arrows" (for arrows), default is "arrows".
#' @param decreasing display order, default is FALSE.
#' @param add whether to add the layer to an existing plot (TRUE) or not (FALSE), default is TRUE
#' @param lwd borders width, default is 1.
#' @param col color of flows, default is "#00FF0090"
#' @param border color of flows borders, default is "#4a0c25"
#' @param k value to increase or decrease the size of the flows (in units of the map), default is NULL. To be improved...
#' @param df2 dataframe containg data to plot proportional circles between flows, default is NULL.
#' @param df2id name of the numeric field in df2, default is "id"
#' @param df2var name of the numeric variable to plot circles.
#' @param k2 value to increase or decrease the size of the circles (in units of the map), default is NULL. To be improved...
#'
#' @return
#' @export
......@@ -110,7 +110,7 @@ plotflows <- function(
border = "#4a0c25",
k = NULL,
df2 = NULL,
df2id,
df2id = "id",
df2var,
k2 = NULL
){
......
......@@ -19,13 +19,45 @@ plotflows(
border = "#4a0c25",
k = NULL,
df2 = NULL,
df2id,
df2id = "id",
df2var,
k2 = NULL
)
}
\arguments{
\item{k2}{}
\item{x}{an sf object (polygon or multipolygons).}
\item{xid}{name of the identifier variable in x, default is "id".}
\item{df}{name of the numeric field in df to plot flows.}
\item{dfid}{name of the two identifier variables in df, default is c("i","j").}
\item{dfvar}{name of the numeric variable to plot flows, default is "fij".}
\item{size}{way of calculating the size of the flows, "thickness" ou "area, default is "thickness".}
\item{type}{type of flows, "rect" (for rectangles) or "arrows" (for arrows), default is "arrows".}
\item{decreasing}{display order, default is FALSE.}
\item{add}{whether to add the layer to an existing plot (TRUE) or not (FALSE), default is TRUE}
\item{lwd}{borders width, default is 1.}
\item{col}{color of flows, default is "#00FF0090"}
\item{border}{color of flows borders, default is "#4a0c25"}
\item{k}{value to increase or decrease the size of the flows (in units of the map), default is NULL. To be improved...}
\item{df2}{dataframe containg data to plot proportional circles between flows, default is NULL.}
\item{df2id}{name of the numeric field in df2, default is "id"}
\item{df2var}{name of the numeric variable to plot circles.}
\item{k2}{value to increase or decrease the size of the circles (in units of the map), default is NULL. To be improved...}
}
\value{
......
Supports Markdown
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