Skip to contents

Apply log transformation to matrix values. Requires matrix to be active. This is a convenience wrapper around transform_matrix().

Usage

log_transform(.data, base = 2, offset = 1)

Arguments

.data

A tidymatrix object with matrix active

base

Logarithm base (2, 10, or "natural" for ln)

offset

Value to add before log transform (default 1, for log(x + 1))

Value

A tidymatrix object with log-transformed matrix

Examples

mat <- matrix(abs(rnorm(20)), nrow = 4, ncol = 5)
tm <- tidymatrix(mat)

# Log2 transform with pseudocount
tm_log <- tm |>
  activate(matrix) |>
  log_transform(base = 2, offset = 1)

# Natural log
tm_ln <- tm |>
  activate(matrix) |>
  log_transform(base = "natural")