sparsevctrs (version 0.3.1)

sparse_mean: Calculate mean from sparse vectors

Description

Calculate mean from sparse vectors

Usage

sparse_mean(x, wts = NULL, na_rm = FALSE)

Value

single numeric value.

Arguments

x

A sparse numeric vector.

wts

A numeric vector, should be same length as x.

na_rm

Logical, whether to remove missing values. Defaults to FALSE.

Details

This function, as with any of the other helper functions assumes that the input x is a sparse numeric vector. This is done for performance reasons, and it is thus the users responsibility to perform input checking.

Examples

sparse_mean(
  sparse_double(1000, 1, 1000)
)

sparse_mean(
  sparse_double(1000, 1, 1000, default = 1)
)

sparse_mean(
  sparse_double(c(10, 50, 11), c(1, 50, 111), 1000)
)

sparse_mean(
  sparse_double(c(10, NA, 11), c(1, 50, 111), 1000)
)

sparse_mean(
  sparse_double(c(10, NA, 11), c(1, 50, 111), 1000),
  na_rm = TRUE
)