colDiffs,dgCMatrix-method {sparseMatrixStats} | R Documentation

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

### Description

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

### Usage

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

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

### Arguments

`x` | An NxK matrix-like object.
`rows` | A `vector` indicating the subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`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.

### 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)

[Package sparseMatrixStats version 0.99.2 Index]