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>
63 lines
1.6 KiB
Markdown
Vendored
63 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: acf
|
|
description: This page provides a detailed description and source code of acf - an
|
|
OpenBB function used to plot Auto and Partial Auto Correlation of returns and change
|
|
in returns. One can understand how to use the function, its parameters, and view
|
|
examples of its use.
|
|
keywords:
|
|
- auto correlation
|
|
- quantitive analysis
|
|
- quantitative_analysis.qa_view.py
|
|
- plots
|
|
- openbb.qa.acf
|
|
- codes
|
|
- parameters
|
|
- returns
|
|
- examples
|
|
- stocks.load
|
|
- GitHub source code
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="qa.acf - Reference | OpenBB SDK Docs" />
|
|
|
|
Plots Auto and Partial Auto Correlation of returns and change in returns
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L372)]
|
|
|
|
```python
|
|
openbb.qa.acf(data: pd.DataFrame, target: str, symbol: str = "", lags: int = 15, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | Dataframe to look at | None | False |
|
|
| target | str | Data column to look at | None | False |
|
|
| symbol | str | Name of dataset | | True |
|
|
| lags | int | Max number of lags to look at | 15 | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (4 axes are expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.stocks.load("AAPL")
|
|
openbb.qa.acf(data=df, target="Adj Close")
|
|
```
|
|
|
|
---
|