Files
OpenBB/website/content/terminal/reference/portfolio/alloc.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

7.8 KiB
Vendored

title, description, keywords
title description keywords
alloc The page serves as a documentation for 'alloc' - a python function that helps users understand their portfolio's allocation to different assets or sectors compared to a benchmark. It includes detailed usage instructions, parameters, and examples of how to use the function.
alloc
asset allocation
sector allocation
benchmark comparison
portfolio management

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Show your allocation to each asset or sector compared to the benchmark.

Usage

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

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%     │
└───────────────┴───────────┴───────────┴────────────┘