diff --git a/R/distance_to_centroid.R b/R/distance_to_centroid.R index a93c6ca1..016dbda1 100644 --- a/R/distance_to_centroid.R +++ b/R/distance_to_centroid.R @@ -29,6 +29,7 @@ #' @param return_rank boolean if rank distance should also be returned, default #' FALSE #' @param ties.method see \code{\link[data.table:frank]{?data.table::frank}} +#' @inheritParams group_pts #' #' @return \code{distance_to_centroid} returns the input \code{DT} appended with #' a \code{distance_centroid} column indicating the distance to group centroid diff --git a/man/distance_to_centroid.Rd b/man/distance_to_centroid.Rd index 6b0022ae..2f471090 100644 --- a/man/distance_to_centroid.Rd +++ b/man/distance_to_centroid.Rd @@ -16,6 +16,9 @@ distance_to_centroid( \item{DT}{input data.table with centroid columns generated by eg. \code{centroid_group}} +\item{coords}{character vector of X coordinate and Y coordinate column names. +Note: the order is assumed X followed by Y column names.} + \item{group}{group column name, generated by \code{group_pts}, default 'group'}