raster (version 1.9-44)

movingFun: Moving functions

Description

Helper function to compute 'moving' functions, such as the 'moving average'

Usage

movingFun(x, n, fun=mean, type='around', circular=FALSE, na.rm=FALSE)

Arguments

x

A vector of numbers

n

Size of the 'window', i.e. the number of sequential elements to use in the function

fun

A function like mean, min, max, sum

type

Character. One of 'around', 'to', or 'from'. The choice indicates which values should be used in the computation. The focal element is always used. If type is 'around', the other elements are before and after the focal element. Alternatively,

circular

Logical. If true, the data are considered to have a circular nature (e.g. months of the year), and the last elements in vector x are used in the computation of the moving function of the first element(s) of the vector, and the fi

na.rm

Logical. If TRUE, NA values should be ingored (by fun)

Value

• Numeric

Examples

movingFun(1:12, 3, mean)
movingFun(1:12, 3, mean, 'to')
movingFun(1:12, 3, mean, 'from')
movingFun(1:12, 3, mean, circular=TRUE)

v <- c(0,1,2,3,3,3,3,4,4,4,5,5,6,7,7,8,9,NA)
movingFun(v, n=5)
movingFun(v, n=5, na.rm=TRUE)