From dd696664f454c995f6f0ed5a31c770550e8670f8 Mon Sep 17 00:00:00 2001 From: Marius Appel Date: Mon, 4 Mar 2024 21:03:17 +0100 Subject: [PATCH] update docs --- R/window.R | 7 ++++--- man/window_time.Rd | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/R/window.R b/R/window.R index 54335ab..94a0969 100644 --- a/R/window.R +++ b/R/window.R @@ -1,7 +1,8 @@ -#' Apply a moving window operations over the time dimension of a data cube +#' Apply a moving window operation over the time dimension of a data cube #' #' Create a proxy data cube, which applies one ore more moving window functions to selected bands over pixel time series of a data cube. -#' The fuction can either use a predefined agggregation function or apply a custom convolution kernel. +#' The function can either apply a built-in aggregation function or apply a custom one-dimensional +#' convolution kernel. #' #' @param x source data cube #' @param kernel numeric vector with elements of the kernel @@ -42,7 +43,7 @@ #' Notice that expressions have a very simple format: the reducer is followed by the name of a band in parantheses. You cannot add #' more complex functions or arguments. #' -#' Possible reducers currently are "min", "max", "sum", "prod", "count", "mean", "median". +#' Possible reducers include "min", "max", "sum", "prod", "count", "mean", and "median". #' #' #' @export diff --git a/man/window_time.Rd b/man/window_time.Rd index 525e295..ab55c3e 100644 --- a/man/window_time.Rd +++ b/man/window_time.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/window.R \name{window_time} \alias{window_time} -\title{Apply a moving window operations over the time dimension of a data cube} +\title{Apply a moving window operation over the time dimension of a data cube} \usage{ window_time(x, expr, ..., kernel, window) } @@ -22,7 +22,8 @@ proxy data cube object } \description{ Create a proxy data cube, which applies one ore more moving window functions to selected bands over pixel time series of a data cube. -The fuction can either use a predefined agggregation function or apply a custom convolution kernel. +The function can either apply a built-in aggregation function or apply a custom one-dimensional +convolution kernel. } \details{ The function either applies a kernel convolution (if the \code{kernel} argument is provided) or a general reducer function @@ -34,7 +35,7 @@ several expressions can be used to create multiple bands in the output cube. Notice that expressions have a very simple format: the reducer is followed by the name of a band in parantheses. You cannot add more complex functions or arguments. -Possible reducers currently are "min", "max", "sum", "prod", "count", "mean", "median". +Possible reducers include "min", "max", "sum", "prod", "count", "mean", and "median". } \note{ Implemented reducers will ignore any NAN values (as na.rm=TRUE does).