qc_check_unsigned: Quality Control Check for Unsigned Values

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Quality Control Check for Unsigned Values

Description

This function performs a quality control check to ensure that a given field value is an unsigned number (i.e., a non-negative number). Optionally, it can also check if the field value matches a specified data type before performing the unsigned check.

Usage

qc_check_unsigned(field_value, expected_type = NULL)

Arguments

field_value	The value to be checked. The function verifies if this value is non-negative. It can be of any type but is typically expected to be a numeric value.
expected_type	An optional parameter specifying the expected data type of field_value. If provided, the function first checks if field_value matches the expected type before verifying if it is unsigned. Default is NULL, which means no type check is performed.

Value

Returns the field_value if it passes the checks: it is of the expected type (if expected_type is not NULL) and is non-negative. If any of the checks fail, the function logs an error message and aborts execution.

SeaSondeR documentation built on June 8, 2025, 10:50 a.m.