clarify range

ropensci · Oct 7, 2024 · 8aecfd1 · 8aecfd1
1 parent 2c3dd37
commit 8aecfd1
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/R/direction_to_centroid.R b/R/direction_to_centroid.R
@@ -22,7 +22,8 @@
 #'
 #' @return \code{direction_to_centroid} returns the input \code{DT} appended
 #'   with a \code{direction_centroid} column indicating the direction to group
-#'   centroid in radians.
+#'   centroid in radians. The direction is measured in radians in the range
+#'   of 0 to 2 * pi from the positive x-axis.
 #'
 #'   A message is returned when \code{direction_centroid} column already exist
 #'   in the input \code{DT}, because they will be overwritten.