diff --git a/R/calc_gsw_change.R b/R/calc_gsw_change.R index 4c3e317e..aac48a5b 100644 --- a/R/calc_gsw_change.R +++ b/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 diff --git a/R/calc_gsw_occurrence.R b/R/calc_gsw_occurrence.R index 9fd51c0b..c8471e65 100644 --- a/R/calc_gsw_occurrence.R +++ b/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 diff --git a/R/calc_gsw_recurrence.R b/R/calc_gsw_recurrence.R index ff02dcdd..eb9c3a6f 100644 --- a/R/calc_gsw_recurrence.R +++ b/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 diff --git a/R/calc_gsw_seasonality.R b/R/calc_gsw_seasonality.R index cec8ed9c..f5b87949 100644 --- a/R/calc_gsw_seasonality.R +++ b/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 diff --git a/R/calc_gsw_transitios.R b/R/calc_gsw_transitios.R index b3b25425..e1d3c162 100644 --- a/R/calc_gsw_transitios.R +++ b/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