rowDiffs: Calculates the difference between each element of a row...

In MatrixGenerics: S4 Generic Summary Statistic Functions that Operate on Matrix-Like Objects

Description

Calculates the difference between each element of a row (column) of a matrix-like object.

Usage

rowDiffs(x, rows = NULL, cols = NULL, lag = 1L, differences = 1L, ...)

## S4 method for signature 'matrix_OR_array_OR_table_OR_numeric'
rowDiffs(x, rows = NULL,
  cols = NULL, lag = 1L, differences = 1L, dim. = dim(x), ...)

## S4 method for signature 'ANY'
rowDiffs(x, rows = NULL, cols = NULL, lag = 1L, differences = 1L, ...)

colDiffs(x, rows = NULL, cols = NULL, lag = 1L, differences = 1L, ...)

## S4 method for signature 'matrix_OR_array_OR_table_OR_numeric'
colDiffs(x, rows = NULL,
  cols = NULL, lag = 1L, differences = 1L, dim. = dim(x), ...)

## S4 method for signature 'ANY'
colDiffs(x, rows = NULL, cols = NULL, lag = 1L, differences = 1L, ...)

Arguments

x	An NxK matrix-like object.
rows, cols	A vector indicating the subset of rows (and/or columns) to operate over. If NULL, no subsetting is done.
lag	An integer specifying the lag.
differences	An integer specifying the order of difference.
...	Additional arguments passed to specific methods.
dim.	An integer vector of length two specifying the dimension of x, essential when x is a numeric vector. Note, that this is not a generic argument and not all methods need provide it.

Details

The S4 methods for x of type matrix, array, or numeric call matrixStats::rowDiffs / matrixStats::colDiffs.

Value

Returns a numeric matrix with one column (row) less than x: Nx(K-1) or (N-1)xK.

See Also

• matrixStats::rowDiffs() and matrixStats::colDiffs() which are used when the input is a matrix or numeric vector.

• base::diff().

Examples

  mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
  mat[2, 1] <- NA
  mat[3, 3] <- Inf
  mat[4, 1] <- 0
  
  print(mat)
  
  rowDiffs(mat)
  colDiffs(mat)
  

MatrixGenerics documentation built on Feb. 1, 2021, 2:01 a.m.