Continuous Statistics
Continuous Statistics Class
- class gval.statistics.continuous_statistics.ContinuousStatistics
Class for Running Continuous Statistics on Agreement Maps
- registered_functions
Available statistical functions with names as keys and parameters as values
- Type:
dict
- available_functions() list
Lists all available functions
- Return type:
List of available functions
- function_signature_check(func)
Validates signature of registered function
- Parameters:
func (function) – Function to check the signature of
- get_all_parameters()
Get all the possible arguments
- Return type:
List of all possible arguments for functions
- get_parameters(func_name: str) list
Get parameters of registered function
- Parameters:
func_name (str) –
- Return type:
List of parameter names for the associated function
- process_statistics(func_names: str | list, **kwargs) Tuple[float, str]
- Parameters:
func_names (Union[str, list]) – Name of registered function to run
**kwargs (dict or keyword arguments) – Dictionary or keyword arguments of to pass to metric functions.
- Returns:
Tuple with metric values and metric names.
- Return type:
Tuple[float, str]
- register_function(name: str)
Register decorator function in statistics class
- Parameters:
name (str) – Name of function to register in statistics class
- Return type:
Decorator function
- register_function_class()
Register decorator function for an entire class
- Parameters:
vectorize_func (bool) – Whether to vectorize the function