update return documentation #17

PaulMelloy · Jul 27, 2024 · e43cf32 · e43cf32
1 parent bc75d8f
commit e43cf32
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/R/read_sb_growth_parameter.R b/R/read_sb_growth_parameter.R
@@ -9,8 +9,9 @@
 #' @param target_res desired spatial resolution. `target_res` should be equal to
 #'  or larger than the actual resolution of the images expressed in meters.
 #'
-#' @return `param_list:` list containing parameters that are necessary to calculate
-#'  `r`, the growth rate.
+#' @return `SpatRast` with a layer for each input layer. Each layer contains is
+#'  named according to the `img_dates`. The output `SpatRast` is suitable for
+#'  input in `calc_r_x0()`
 #'
 #' @export
 #'

diff --git a/man/read_sb_growth_parameter.Rd b/man/read_sb_growth_parameter.Rd