specify resulting tibble columns in gsw calc function documentation.

R/calc_gsw_change.R

@@ -17,7 +17,8 @@
 #' "extract" or "exactextract". Default: "extract".
 #' @param stats_gsw Aggregation function with which the data are combined.
 #' Default: "mean".
-#' @return A tibble
+#' @return A tibble containing the aggregated GSW change indicator. The column
+#' name is a concatenation of "global_surface_water_change_" + \code{stats_gsw}.
 #' @keywords internal
 #' @include register.R
 #' @noRd

R/calc_gsw_occurrence.R

@@ -15,7 +15,9 @@
 #' "extract" or "exactextract". Default: "extract".
 #' @param stats_gsw Aggregation function with which the data are combined.
 #' Default: "mean".
-#' @return A tibble
+#' @return A tibble containing the aggregated occurrence indicator. The column
+#' name is a concatenation of "global_surface_water_occurrence_" +
+#' \code{stats_gsw}.
 #' @keywords internal
 #' @include register.R
 #' @noRd

R/calc_gsw_recurrence.R

@@ -16,7 +16,9 @@
 #' "extract" or "exactextract". Default: "extract".
 #' @param stats_gsw Aggregation function with which the data are combined.
 #' Default: "mean".
-#' @return A tibble
+#' @return A tibble containing the aggregated recurrence indicator. The column
+#' name is a concatenation of "global_surface_water_recurrence_" +
+#' \code{stats_gsw}.
 #' @keywords internal
 #' @include register.R
 #' @noRd

R/calc_gsw_seasonality.R

@@ -13,7 +13,9 @@
 #' "extract" or "exactextract". Default: "extract".
 #' @param stats_gsw Aggregation function with which the data are combined.
 #' Default: "mean".
-#' @return A tibble
+#' @return A tibble containing the aggregated seasonality indicator. The column
+#' name is a concatenation of "global_surface_water_seasonality_" +
+#' \code{stats_gsw}.
 #' @keywords internal
 #' @include register.R
 #' @noRd

R/calc_gsw_transitios.R

@@ -21,7 +21,11 @@
 #'
 #' @param x A single polygon for which to calculate the GSW statistics.
 #' @param global_surface_water_transitions The GSW Transitions data source.
-#' @return A tibble
+#' @return A tibble with two columns
+#' \itemize{
+#'   \item class: Surface water transition class
+#'   \item area: Area in ha.
+#' }
 #' @keywords internal
 #' @include register.R
 #' @noRd