diff options
Diffstat (limited to 'openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py')
| -rw-r--r-- | openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py | 33 |
1 files changed, 30 insertions, 3 deletions
diff --git a/openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py b/openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py index 0065ec62011..3b5ff224047 100644 --- a/openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py +++ b/openbb_platform/extensions/quantitative/openbb_quantitative/quantitative_router.py @@ -1,5 +1,7 @@ """Quantitative Analysis Router.""" +# pylint: disable=unused-argument + from typing import List, Literal import pandas as pd @@ -49,7 +51,11 @@ router.include_router(performance_router) APIEx(parameters={"target": "close", "data": APIEx.mock_data("timeseries", 8)}), ], ) -def normality(data: List[Data], target: str) -> OBBject[NormalityModel]: +def normality( + data: List[Data], + target: str, + **extra_params, +) -> OBBject[NormalityModel]: """Get Normality Statistics. - **Kurtosis**: whether the kurtosis of a sample differs from the normal distribution. @@ -64,6 +70,9 @@ def normality(data: List[Data], target: str) -> OBBject[NormalityModel]: Time series data. target : str Target column name. + **extra_params : Optional[Dict[str, Any]] + Extra parameters to be passed to the command execution. + API POST requests are sent in the body with data. Returns ------- @@ -107,7 +116,11 @@ def normality(data: List[Data], target: str) -> OBBject[NormalityModel]: ), ], ) -def capm(data: List[Data], target: str) -> OBBject[CAPMModel]: +def capm( + data: List[Data], + target: str, + **extra_params, +) -> OBBject[CAPMModel]: """Get Capital Asset Pricing Model (CAPM). CAPM offers a streamlined way to assess the expected return on an investment while accounting for its risk relative @@ -120,6 +133,9 @@ def capm(data: List[Data], target: str) -> OBBject[CAPMModel]: Time series data. target : str Target column name. + **extra_params : Optional[Dict[str, Any]] + Extra parameters to be passed to the command execution. + API POST requests are sent in the body with data. Returns ------- @@ -175,6 +191,7 @@ def unitroot_test( target: str, fuller_reg: Literal["c", "ct", "ctt", "nc", "c"] = "c", kpss_reg: Literal["c", "ct"] = "c", + **extra_params, ) -> OBBject[UnitRootModel]: """Get Unit Root Test. @@ -196,6 +213,9 @@ def unitroot_test( Regression type for ADF test. kpss_reg : Literal["c", "ct"] Regression type for KPSS test. + **extra_params : Optional[Dict[str, Any]] + Extra parameters to be passed to the command execution. + API POST requests are sent in the body with data. Returns ------- @@ -241,7 +261,11 @@ def unitroot_test( APIEx(parameters={"target": "close", "data": APIEx.mock_data("timeseries", 5)}), ], ) -def summary(data: List[Data], target: str) -> OBBject[SummaryModel]: +def summary( + data: List[Data], + target: str, + **extra_params, +) -> OBBject[SummaryModel]: """Get Summary Statistics. The summary that offers a snapshot of its central tendencies, variability, and distribution. @@ -257,6 +281,9 @@ def summary(data: List[Data], target: str) -> OBBject[SummaryModel]: Time series data. target : str Target column name. + **extra_params : Optional[Dict[str, Any]] + Extra parameters to be passed to the command execution. + API POST requests are sent in the body with data. Returns ------- |