Coverage for src / ts_stat_tests / linearity / __init__.py: 100%

1# ============================================================================ # 

2# # 

3# Title: Linearity Module # 

4# Purpose: Initialize the linearity module by importing algorithms and # 

5# tests, and defining exports. # 

6# # 

7# ============================================================================ # 

8 

9 

10# ---------------------------------------------------------------------------- # 

11# # 

12# Overview #### 

13# # 

14# ---------------------------------------------------------------------------- # 

15 

16 

17# ---------------------------------------------------------------------------- # 

18# Description #### 

19# ---------------------------------------------------------------------------- # 

20 

21 

22""" 

23!!! note "Summary" 

24 This module provides tools to assess the linearity of time series data. It includes various algorithms and tests to evaluate whether a time series exhibits linear behavior, helping to identify relationships and trends within the data. 

25""" 

26 

27 

28# ---------------------------------------------------------------------------- # 

29# # 

30# Setup #### 

31# # 

32# ---------------------------------------------------------------------------- # 

33 

34 

35# ---------------------------------------------------------------------------- # 

36# Imports #### 

37# ---------------------------------------------------------------------------- # 

38 

39 

40# ## Local First Party Imports ---- 

41from ts_stat_tests.linearity.algorithms import hc, lm, rb, rr 

42from ts_stat_tests.linearity.tests import is_linear, linearity 

43 

44 

45# ---------------------------------------------------------------------------- # 

46# Exports #### 

47# ---------------------------------------------------------------------------- # 

48 

49 

50__all__: list[str] = ["hc", "lm", "rb", "rr", "linearity", "is_linear"]