Convenience helper to use a stored weight array for reduction

Custom weights are currently unsupported by the built-in registered reducers; passing the result to reduce() with such a reducer raises an informative error instead of silently running an inverse-variance analysis. Only reducers that declare "custom" in options_schema$weights accept it.

Usage

use_weight(g, name)

Arguments

g

A realised GDS containing the weight assay

name

Assay name to use as custom weights

Value

A list(list) suitable to splice into reduce(): list(weights = "custom", options = list(custom_weights = ))

Examples

# opts <- use_weight(g2, "w_custom")