quantile
Compute the quantile of a target column at a specified percentage.
Quantiles are points dividing the range of a distribution into intervals with equal probabilities. The median (0.5 quantile) is returned alongside the requested quantile.
Examples
from openbb import obb
obb.quantitative.stats.quantile(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])
Parameters
- standard
data: Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray
Input dataset.
target: str
Name of the column to analyze.
quantile_pct: float
Default: 0.5
Quantile to compute, between 0 and 1.
Returns
results: StatsQuantileData
Serializable results.
provider: str
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
median: float
Median (0.5 quantile) of the distribution.
quantile: float
Value at the requested quantile.