Validates whether a frequency string is among the allowed options for KuCoin klines data.
Usage
check_allowed_frequency_str(freq_str)
Arguments
- freq_str
Character string representing the frequency (e.g., "1min", "3min").
Value
Invisible NULL if valid; aborts with an error if invalid.
Details
Workflow Overview
Validation: Checks if freq_str exists in freq_to_second_map, aborting with an error message listing allowed values if not.
API Endpoint
Not applicable (helper validation function).
Usage
Utilised to ensure frequency inputs for klines data retrieval are valid before API calls.
Official Documentation
Not directly tied to a specific endpoint; see KuCoin klines API documentation for frequency options.
Examples
if (FALSE) { # \dontrun{
check_allowed_frequency_str("1min") # Proceeds silently
check_allowed_frequency_str("10min") # Aborts with error
} # }