char_validate_params: Validate CharAnalysis input parameters

View source: R/char_validate_params.R

char_validate_paramsR Documentation

Validate CharAnalysis input parameters

Description

Checks all user-supplied parameters for internal consistency and plausible ranges. Throws a descriptive error and halts if any check fails. Emits warnings for non-fatal but unusual settings.

Usage

char_validate_params(
  char_data,
  pretreatment,
  smoothing,
  peak_analysis,
  results
)

Arguments

char_data

Numeric matrix (n x 6+).

pretreatment

List with zoneDiv, yrInterp, transform.

smoothing

List with method, yr.

peak_analysis

List with cPeak, threshType, threshMethod, threshValues, minCountP, peakFrequ.

results

List (not checked; included for API symmetry).

Details

Mirrors CharValidateParams.m from the MATLAB v2.0 codebase. All 15 checks and 2 non-fatal warnings are reproduced in the same order.

Value

NULL invisibly on success. Stops with an error on failure.

See Also

[char_parameters()], [CharAnalysis()]


CharAnalysis documentation built on May 3, 2026, 5:06 p.m.