mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
40 lines
1.3 KiB
Markdown
Vendored
40 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: quantile
|
|
description: This documentation page provides detailed information on the concept
|
|
of quantile, a statistical term which refers to the values that divide a set of
|
|
observations into specified proportions. The page also includes parameters for customizing
|
|
the quantile function.
|
|
keywords:
|
|
- Quantile
|
|
- Distribution
|
|
- Median
|
|
- n_window
|
|
- f_quantile
|
|
- Parameters
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy/qa/quantile - Reference | OpenBB Terminal Docs" />
|
|
|
|
The quantiles are values which divide the distribution such that there is a given proportion of observations below the quantile. For example, the median is a quantile. The median is the central value of the distribution, such that half the points are less than or equal to it and half are greater than or equal to it. By default, q is set at 0.5, which effectively is median. Change q to get the desired quantile (0q1).
|
|
|
|
### Usage
|
|
|
|
```python
|
|
quantile [-w N_WINDOW] [-q F_QUANTILE]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| n_window | window length | 14 | True | None |
|
|
| f_quantile | quantile | 0.5 | True | None |
|
|
|
|
|
|
|
|
---
|