validate_spline_df: Validate the 'spline_df' argument for spline detrending

View source: R/pipeline-detrend.R

validate_spline_dfR Documentation

Validate the spline_df argument for spline detrending

Description

Ensures spline_df (the degrees of freedom for the natural cubic spline basis used by detrend() when method = "spline") is a single whole number ⁠>= 1⁠, aborting with an informative error otherwise.

Usage

validate_spline_df(spline_df)

Arguments

spline_df

The candidate degrees-of-freedom value to validate

Value

The validated value coerced to an integer


eyeris documentation built on Aug. 1, 2026, 1:07 a.m.