linear_filter: Fit a linear filter over a label matrix

Description Usage Arguments Details Value Examples

View source: R/linear_filter.R

Description

This function fits a linear filter over a label matrix. It calculates the row, column and total means, and uses those to construct the linear filter.

Usage

1
linear_filter(y, alpha = 0.25, na.rm = FALSE)

Arguments

y

a label matrix

alpha

a vector with 4 alpha values, or a single alpha value which then is used for all 4 alphas.

na.rm

a logical value indicating whether missing values should be removed before calculating the row-, column- and total means.

Details

If there are missing values and they are removed before calculating the means, a warning is issued. If na.rm = FALSE and there are missing values present, the outcome is, by definition, a matrix filled with NA values.

Value

an object of class linearFilter

Examples

1
2
3

xnet documentation built on Feb. 4, 2020, 9:10 a.m.