Skip to main content

quantile

Calculate the quantile of a target column at a specified quantile percentage.

Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities, or dividing the sample in the same way.

Examples​

from openbb import obb
# Get Quantile.
stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df()
returns = stock_data["close"].pct_change().dropna()
obb.quantitative.stats.quantile(data=returns, target="close", quantile_pct=0.75)
obb.quantitative.stats.quantile(target='close', data='[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]')

Parameters​

data: list[openbb_core.provider.abstract.data.Data]
The time series data as a list of data points.

target: str
The name of the column for which to calculate the quantile.

quantile_pct: float
Default: 0.5
The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5.

Returns​

results: list[Data]

Serializable results.

provider: None

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

On this page