step_measure_peaks_detect() creates a specification of a recipe step that
detects peaks in measurement data and stores them in a new .peaks column.
Arguments
- recipe
A recipe object.
- algorithm
Peak detection algorithm. One of
"prominence"(default),"derivative","local_maxima","cwt", or any algorithm registered viaregister_peak_algorithm(). Usepeak_algorithms()to see available algorithms.- min_height
Minimum peak height in the measurement's signal units. If
snr_threshold = TRUE, the existing logical mode interprets this as a multiple of the signal's median absolute deviation (MAD).- min_distance
Minimum distance between peaks in x-axis units.
- min_prominence
Minimum peak prominence (only for
algorithm = "prominence").- snr_threshold
FALSE(default) disables SNR filtering;TRUEretains the legacy behavior of interpretingmin_heightas an SNR multiple. A non-negative number sets an additional minimum SNR threshold in MAD units. In numeric mode, a candidate must meet both the absolutemin_heightand SNR thresholds. A numeric value of zero adds no SNR filtering.- algorithm_params
Named list of additional algorithm-specific parameters. These are passed to the algorithm function along with the standard parameters.
- measures
Optional character vector of measure column names.
- role
Not used.
- trained
Logical indicating if the step has been trained.
- skip
Logical. Should the step be skipped when baking?
- id
Unique step identifier.
Details
This step detects peaks in measurement data and creates a new .peaks
column containing the detected peaks for each sample. The original
.measures column is preserved.
Detection algorithms:
"prominence"(default): Finds local maxima and calculates their prominence (the height above the surrounding contour). Usemin_prominenceto exclude maxima below the chosen prominence threshold."derivative": Finds peaks by detecting zero-crossings in the first derivative. Noise can introduce additional zero-crossings."local_maxima": Finds local maxima above the chosen height threshold, including maxima caused by noise."cwt": Links Mexican-hat wavelet maxima across widths to identify persistent peaks. Requires a uniformly spaced axis. See peak_detection_cwt for widths, local SNR, missing data, and limits.
Additional algorithms can be registered by technique packs using
register_peak_algorithm().
The detection thresholds are tunable with peak_min_height(),
peak_min_distance(), peak_min_prominence(), and
peak_snr_threshold(). The default search ranges are only starting points:
height and prominence use signal units, distance uses x-axis units, and SNR
uses MAD units. Adjust the ranges to the measurement scale. Prominence is
offered as a tunable threshold only for the built-in prominence algorithm.
Tuning covers these direct scalar arguments; values inside
algorithm_params are not extracted as recipe tuning parameters.
Peak properties stored:
peak_id: Integer identifierlocation: X-axis position of peak apexheight: Y-value at peak apexleft_base,right_base: X-axis positions of peak integration boundsprominence_left_base,prominence_right_base: Original contour bases for prominence-based detectionarea: Initially NA; usestep_measure_peaks_integrate()to calculate
For algorithm = "prominence", each pair of adjacent retained peaks is
bounded at the lowest sampled value between their apexes. If values tie, the
first sample in acquisition order is used. These bounds do not overlap in
their interiors. The original prominence contour bases are retained in
prominence_left_base and prominence_right_base for prominence
calculations. This rule considers retained peaks only, so a filtered-out
neighboring peak does not create a boundary. A low sample can also be far
from its peak on a noisy or sloped baseline, so these bounds do not by
themselves remove baseline or noise bias.
Deconvolution uses current left_base and right_base as finite limits, so
fitted areas omit model tails outside them.
Use step_measure_peaks_properties() to calculate additional peak metrics
such as prominence and full width at half maximum (FWHM).
Examples
library(recipes)
rec <- recipe(water + fat + protein ~ ., data = meats_long) |>
update_role(id, new_role = "id") |>
step_measure_input_long(transmittance, location = vars(channel)) |>
step_measure_peaks_detect(min_height = 0.5, min_distance = 5) |>
prep()
result <- bake(rec, new_data = NULL)
# Result now has .peaks column alongside .measures
# Use a different algorithm
rec2 <- recipe(water + fat + protein ~ ., data = meats_long) |>
update_role(id, new_role = "id") |>
step_measure_input_long(transmittance, location = vars(channel)) |>
step_measure_peaks_detect(algorithm = "derivative", min_height = 0.5) |>
prep()