man-roxygen/param-aggr_channels.R

#' @param aggr_channels (`character(1)` or [`function`])\cr
#' Pass one of `'norm'`, `'sum'`, `'mean'` or a
#' custom function to aggregate the channels, e.g., the maximum
#' ([base::max]) or minimum ([base::min]) over the channels or only
#' individual channels with `function(x) x[1]`. By default (`'sum'`),
#' the sum of all channels is used.\cr
#' *Note:* This argument is used only for 2D and 3D input data.\cr
bips-hb/innsight documentation built on April 14, 2025, 6:01 p.m.