This function replaces spatial coordinate values with NA if the confidence
values are below a specified threshold. The confidence column is also
masked.
Usage
mask_na_confidence(
data,
threshold = 0.6,
confidence = NULL,
missing = c("keep", "mask")
)Arguments
- data
A data frame of numeric coordinate columns — typically supplied by
dplyr::pick()insidedplyr::mutate(). To mask a whole aniframe, usemask_na_across().- threshold
A numeric value specifying the minimum confidence level to retain data. Must be a single value between 0 and 1. Default is 0.6.
- confidence
Numeric vector of confidence values, one per row.
- missing
What to do with rows whose confidence is
NA."keep"(the default) leaves them unmasked;"mask"treats a missing score as failing the threshold, so they are masked like any low-confidence row.
Details
A missing confidence means not assessed, not assessed as poor, so by
default those rows are left unmasked. A human annotator has no natural
number to enter for "I did not assess this", and tracker scores are not
bounded at 1 — SLEAP can exceed it — so NA is the sensible thing to
record rather than a sentinel value. Set missing = "mask" when you would
rather drop what was never assessed.
When missing is left at its default, a warning reports how many rows
were left unmasked without a score, since silently skipping them would hide that
they were never checked. Rows whose coordinates are already all NA are
not counted: masking could not change them. Supplying missing, either
value, says you have decided, and silences the warning.
Input shape
Takes and returns a frame of coordinate columns, so it composes inside
dplyr::mutate():
data |> mutate(
mask_na_confidence(pick(all_of(c("x", "y"))), confidence = confidence)
)The decision uses all coordinates at once, so this cannot be used with
dplyr::across(). confidence is not a coordinate and so is never
modified here; mask_na_across() masks it as well.
Examples
coords <- data.frame(x = 1:5, y = 6:10)
mask_na_confidence(
coords,
threshold = 0.6,
confidence = c(0.5, 0.7, 0.4, 0.8, 0.9)
)
#> x y
#> 1 NA NA
#> 2 2 7
#> 3 NA NA
#> 4 4 9
#> 5 5 10
# Row 3 was never scored: kept by default, masked on request
scores <- c(0.5, 0.7, NA, 0.8, 0.9)
mask_na_confidence(coords, confidence = scores, missing = "keep")
#> x y
#> 1 NA NA
#> 2 2 7
#> 3 3 8
#> 4 4 9
#> 5 5 10
mask_na_confidence(coords, confidence = scores, missing = "mask")
#> x y
#> 1 NA NA
#> 2 2 7
#> 3 NA NA
#> 4 4 9
#> 5 5 10