Skip to contents

Summarise a set of band comparisons

Source: R/metrics.R
band_summary.Rd

Scores the criterion "inside the IBM replicate band" over a set of cells.

Usage

band_summary(value, lower, upper)

Arguments

value

Numeric vector of candidate values.

lower, upper

Numeric vectors of band edges, the same length as value, for example from replicate_band(). It is an error if lower exceeds upper.

Value

A list with n, the number of cells; n_inside, the number inside the band; n_missing, the number with a missing value or edge; and worst, the band_position() of largest magnitude (0 when every scored cell is inside, NA when none can be scored).