Files
OpenBB/website/content/terminal/reference/portfolio/alloc.md
teh_coderer 79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

103 lines
7.3 KiB
Markdown
Vendored

---
title: alloc
description: OpenBB Terminal Function
---
# alloc
Show your allocation to each asset or sector compared to the benchmark.
### Usage
```python
alloc [-a AGG] [-t]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| agg | The type of allocation aggregation you wish to do | assets | True | assets, sectors, countries, regions |
| tables | Whether to also include the assets/sectors tables of both the benchmark and the portfolio. | False | True | None |
---
## Examples
```python
022 May 12, 06:23 (🦋) /portfolio/ $ alloc assets
Portfolio vs. Benchmark - Top 10 Assets Allocation
┏━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Symbol ┃ Portfolio ┃ Benchmark ┃ Difference ┃
┡━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ ASML │ 24.44% │ 0.00e+00 │ 24.44% │
├────────┼───────────┼───────────┼────────────┤
│ AMZN │ 21.96% │ 3.33% │ 18.63% │
├────────┼───────────┼───────────┼────────────┤
│ GOOGL │ 18.94% │ 1.66% │ 17.28% │
├────────┼───────────┼───────────┼────────────┤
│ TSM │ 9.43% │ 0.00e+00 │ 9.43% │
├────────┼───────────┼───────────┼────────────┤
│ DGX │ 6.23% │ 0.00e+00 │ 6.23% │
├────────┼───────────┼───────────┼────────────┤
│ BABA │ 5.54% │ 0.00e+00 │ 5.54% │
├────────┼───────────┼───────────┼────────────┤
│ APTV │ 3.78% │ 0.00e+00 │ 3.78% │
├────────┼───────────┼───────────┼────────────┤
│ AAPL │ 3.36% │ 4.90% │ -1.54% │
├────────┼───────────┼───────────┼────────────┤
│ NKE │ 3.26% │ 0.00e+00 │ 3.26% │
├────────┼───────────┼───────────┼────────────┤
│ YUM │ 3.06% │ 0.00e+00 │ 3.06% │
└────────┴───────────┴───────────┴────────────┘
2022 May 12, 06:23 (🦋) /portfolio/ $ alloc sectors
Portfolio vs. Benchmark - Top 4 Sectors Allocation
┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Sectors ┃ Portfolio ┃ Benchmark ┃ Difference ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ Technology │ 59.19% │ 24.95% │ 34.24% │
├────────────────────────┼───────────┼───────────┼────────────┤
│ Communication Services │ 18.94% │ 8.55% │ 10.39% │
├────────────────────────┼───────────┼───────────┼────────────┤
│ Consumer Cyclical │ 15.64% │ 11.55% │ 4.09% │
├────────────────────────┼───────────┼───────────┼────────────┤
│ Healthcare │ 6.23% │ 13.41% │ -7.18% │
└────────────────────────┴───────────┴───────────┴────────────┘
2022 May 12, 06:23 (🦋) /portfolio/ $ alloc countries
Portfolio vs. Benchmark - Top 5 Countries Allocation
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Countries ┃ Portfolio ┃ Benchmark ┃ Difference ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ United States │ 57.33% │ 99.17% │ -41.84% │
├───────────────┼───────────┼───────────┼────────────┤
│ Netherlands │ 24.44% │ 0.00e+00 │ 24.44% │
├───────────────┼───────────┼───────────┼────────────┤
│ Taiwan │ 9.43% │ 1.00e-04 │ 9.42% │
├───────────────┼───────────┼───────────┼────────────┤
│ China │ 5.54% │ 0.00e+00 │ 5.54% │
├───────────────┼───────────┼───────────┼────────────┤
│ Germany │ 3.26% │ 0.00e+00 │ 3.26% │
└───────────────┴───────────┴───────────┴────────────┘
2022 May 12, 06:23 (🦋) /portfolio/ $ alloc regions
Portfolio vs. Benchmark - Top 3 Regions Allocation
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Regions ┃ Portfolio ┃ Benchmark ┃ Difference ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ North America │ 57.33% │ 99.25% │ -41.92% │
├───────────────┼───────────┼───────────┼────────────┤
│ Europe │ 27.70% │ 0.64% │ 27.06% │
├───────────────┼───────────┼───────────┼────────────┤
│ Asia │ 14.96% │ 7.00e-04 │ 14.89% │
└───────────────┴───────────┴───────────┴────────────┘
```
---