ebnm_check_fn: Check a custom ebnm function

In ebnm: Solve the Empirical Bayes Normal Means Problem

Check a custom ebnm function

Description

Checks inputs and outputs of an ebnm-style function. Designed to troubleshoot custom functions, especially those that are intended for use in the flashier package (e.g., as argument to the ebnm_fn parameter in function flash).

Usage

ebnm_check_fn(fn, x, s)

Arguments

fn	The function to be checked.
x	A test set (vector) of observations.
s	A test set of standard errors. Typically, ebnm-style functions should be able to accept a vector of standard errors or a scalar if all standard errors are identical. This is not always the case; for example, the horseshoe prior family requires homoskedastic standard errors.

Value

Prints a success message and silently returns 1 if all checks pass. Otherwise the function errors out.

Examples

ebnm_check_fn(ebnm_normal, x = rnorm(10, sd = 2), s = 1)

ebnm documentation built on Sept. 11, 2025, 1:07 a.m.