LG_sanity_checks: Sanity-check the arguments of the major exported functions

In LAJordanger/localgaussSpec: Local Gaussian Spectral Analysis

Sanity-check the arguments of the major exported functions

Description

This internal function checks that the arguments of some of the major exported functions are valid, and it will also adjust/standardise some of the values in the environment of the function under investigation.

Usage

LG_sanity_checks(spy_report)

Arguments

spy_report

The result returned by spy when used on the targeted function.

Value

The execution will be stopped if any erroneous arguments are detected, in which case information about the problem(s) will be returned to the workspace. If no problems are found, the programs returns nothing. Note that this function works upon a shortcut to the environment part of spy_report, and this implies that any adjustments performed by this function are registered in the corresponding spy_report-environment in the calling function.

LAJordanger/localgaussSpec documentation built on May 6, 2023, 4:31 a.m.