From 1009ffccbe350832dacfa0a26b5bd0afb46278a4 Mon Sep 17 00:00:00 2001 From: Danglewood <85772166+deeleeramone@users.noreply.github.com> Date: Wed, 8 Dec 2021 01:51:20 -0800 Subject: [PATCH] New Sector Analysis Menue (#1037) * Added image/updated URL * Added image/updated source URL * Added image/updated URL * updated text * Added image/updated source URL * command does not exist. * replacing accidental deletion * Added image/updated URL * Added image/updated URL * Added Images * added image * Added image * Added image. * Updated text. * Updated text * added image. * updated text * added image * Spelling * Spelling * Spelling * Added image/source URL * Updated description * updated description * Updated text/added image * changed word * Updated description/added image. * added image/updated text * Updated text * added image/updated text * Added image * added image * added image. * added image * added image * added image * added image * added image * added image * added sample * added images * added image * added image * added image * added image * added image * added image * added image * added image * added image * added image * added link to country codes * added image * added image * added image * added image * added image. * added image * added image/updated text * added image * added image/updated text * added image * added image * added image * Added image/updated description * added image * added image/updated description * added image/updated description * added image/updated description * added image/updated description. * added image/updated description * updated text * Updated text * added image * added image/updated text * Added image/updated description. * added image * updated text * added image/updated description * added image/update description * added image * added image * updated text * added image * added image * added image/updated description. * Create _index.md * Create _index.md * updated image/description * added image/updated description * added image * added image * added image * added image * added additional image * Updated description. * updated image/description. * Updated image/description * updated image/description. * updated image/description. * updated description. * updated image/description. * updated image/description. * updated image/description. * updated image/added description. * updated image/description. * updated image/description. * updated image/description. * Updated description. * updated description. * updated description. * added image * updated text * updated text * updated url * updated URL * updated image * updated url * updated url * added sample output * updated description. * updated description * Updated text * added image/updated description. * updated description. * updated description. * updated link. * updated description. * updated description. * added image/updated description. * Updated description. * Updated description. * added sample output * updated description * updated description * updated image/description * added sample output/updated description. * added sample output/updated description * updated image/description. * updated description. * added image/updated description. * updated description. * added image/updated description. * updated description. * added image/updated description. * added image/updated description * updated description. * added image/updated description. * updated description/added image * spelling * Update labels.yml updated label from none to 'website' * updated to remove error * added image * added image * updated image * added image * added image * added image * added image * added image * added image * added image * added image * added sample output * updated image/description. * updated image/description. * updated image/description * updated image * updated description. * updated image/description * updated image/description. * updated description. * updated image * updated image * updated image/description * adding SIA directory * added submenu description * added description * added description * added description. * Delete industry * added description. * added description. * Added description * added description * added image/description * added image/description. * added image/description. * added image/description. * added image/description * added image/description * added image/description * added image/description. * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * added image/description * updated description * Update and rename website/content/stocks/sia/cpi/_index.md to website/content/stocks/sia/cpic/_index.md * updated description * Delete website/content/stocks/sia/cr directory * Delete website/content/stocks/sia/de directory * Delete website/content/stocks/sia/ebitda directory * Delete website/content/stocks/sia/ebitdam directory * Delete website/content/stocks/sia/eg directory * added image/description * added image/description * added image/description * Delete website/content/stocks/sia/fcf directory * Delete website/content/stocks/sia/gm directory * Delete website/content/stocks/sia/gp directory * Delete website/content/stocks/sia/ocf directory * Delete website/content/stocks/sia/om directory * Delete website/content/stocks/sia/pm directory * Delete website/content/stocks/sia/qr directory * Delete website/content/stocks/sia/rec directory * Delete website/content/stocks/sia/rg directory * Delete website/content/stocks/sia/roa directory * Delete website/content/stocks/sia/roe directory * Delete website/content/stocks/sia/rps directory * Delete website/content/stocks/sia/tc directory * Delete website/content/stocks/sia/tcs directory * Delete website/content/stocks/sia/td directory * Delete website/content/stocks/sia/tr directory * added description * added description * added image/description * added Sector and Industry Analysis to directory Co-authored-by: jmaslek --- website/content/stocks/sia/_index.md | 41 +++ website/content/stocks/sia/clear/_index.md | 12 + website/content/stocks/sia/country/_index.md | 72 +++++ website/content/stocks/sia/cpci/_index.md | 18 ++ website/content/stocks/sia/cpcs/_index.md | 18 ++ website/content/stocks/sia/cpic/_index.md | 19 ++ website/content/stocks/sia/cpis/_index.md | 18 ++ website/content/stocks/sia/cps/_index.md | 18 ++ website/content/stocks/sia/exchange/_index.md | 10 + website/content/stocks/sia/industry/_index.md | 255 ++++++++++++++++++ website/content/stocks/sia/load/_index.md | 78 ++++++ website/content/stocks/sia/metric/_index.md | 20 ++ website/content/stocks/sia/mktcap/_index.md | 12 + website/content/stocks/sia/sama/_index.md | 48 ++++ website/content/stocks/sia/sector/_index.md | 33 +++ website/data/menu/main.yml | 31 +++ 16 files changed, 703 insertions(+) create mode 100644 website/content/stocks/sia/_index.md create mode 100644 website/content/stocks/sia/clear/_index.md create mode 100644 website/content/stocks/sia/country/_index.md create mode 100644 website/content/stocks/sia/cpci/_index.md create mode 100644 website/content/stocks/sia/cpcs/_index.md create mode 100644 website/content/stocks/sia/cpic/_index.md create mode 100644 website/content/stocks/sia/cpis/_index.md create mode 100644 website/content/stocks/sia/cps/_index.md create mode 100644 website/content/stocks/sia/exchange/_index.md create mode 100644 website/content/stocks/sia/industry/_index.md create mode 100644 website/content/stocks/sia/load/_index.md create mode 100644 website/content/stocks/sia/metric/_index.md create mode 100644 website/content/stocks/sia/mktcap/_index.md create mode 100644 website/content/stocks/sia/sama/_index.md create mode 100644 website/content/stocks/sia/sector/_index.md diff --git a/website/content/stocks/sia/_index.md b/website/content/stocks/sia/_index.md new file mode 100644 index 00000000000..f31401c5a4c --- /dev/null +++ b/website/content/stocks/sia/_index.md @@ -0,0 +1,41 @@ +--- +geekdocCollapseSection: true +--- + +{{< toc-tree >}} + +```text +Sector and Industry Analysis: + cls clear screen + ?/help show this menu again + q quit this menu, and shows back to main menu + quit quit to abandon program + load load a ticker and get its industry, sector, country and market cap + + clear clear all or one of industry, sector, country and market cap parameters + industry see existing industries, or set industry if arg specified + sector see existing sectors, or set sector if arg specified + country see existing countries, or set country if arg specified + mktcap set mktcap between small, mid or large + exchange revert exclude international exchanges flag + +Industry : Financial Data & Stock Exchanges +Sector : Financial Services +Country : United States +Market Cap : Large +Exclude Exchanges : True + +Statistics + cps companies per Sector based on Country and Market Cap + cpic companies per Industry based on Country and Market Cap + cpis companies per Industry based on Sector and Market Cap + cpcs companies per Country based on Sector and Market Cap + cpci companies per Country based on Industry and Market Cap + +Financials + sama see all metrics available + metric visualise financial metric across filters selected + +Returned tickers: +> ca take these to comparison analysis menu +``` diff --git a/website/content/stocks/sia/clear/_index.md b/website/content/stocks/sia/clear/_index.md new file mode 100644 index 00000000000..a6f582d4039 --- /dev/null +++ b/website/content/stocks/sia/clear/_index.md @@ -0,0 +1,12 @@ +```text +usage: clear [-p {industry,sector,country,mktcap}] [-h] +``` + +Clear all or a particular parameter + +``` +optional arguments: + -p {industry,sector,country,mktcap}, --parameter {industry,sector,country,mktcap} + parameter to clear (default: None) + -h, --help show this help message (default: False) + ``` diff --git a/website/content/stocks/sia/country/_index.md b/website/content/stocks/sia/country/_index.md new file mode 100644 index 00000000000..4c83f9828e3 --- /dev/null +++ b/website/content/stocks/sia/country/_index.md @@ -0,0 +1,72 @@ +```text +usage: country [-n NAME [NAME ...]] [-h] +``` + +See existing countries, or set country if arg specified + +``` +optional arguments: + -n NAME [NAME ...], --name NAME [NAME ...] + country to select (default: None) + -h, --help show this help message (default: False) +``` + +List of countries +``` +Australia +Austria +Belgium +Bermuda +Brazil +British Virgin Islands +Canada +Cayman Islands +Chile +China +Colombia +Cyprus +Denmark +Finland +France +Germany +Greece +Guernsey +Hong Kong +India +Indonesia +Ireland +Isle of Man +Israel +Italy +Japan +Jersey +Latvia +Lithuania +Luxembourg +Malaysia +Malta +Mauritius +Mexico +Myanmar +Netherlands +Netherlands Antilles +New Zealand +Norway +Poland +Portugal +Qatar +Russia +Saudi Arabia +Singapore +Slovenia +South Africa +South Korea +Spain +Sweden +Switzerland +Taiwan +Thailand +Turkey +United Kingdom +United States +``` diff --git a/website/content/stocks/sia/cpci/_index.md b/website/content/stocks/sia/cpci/_index.md new file mode 100644 index 00000000000..01aee05c213 --- /dev/null +++ b/website/content/stocks/sia/cpci/_index.md @@ -0,0 +1,18 @@ +```text +usage: cpci [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Companies per Country based on Industry and Market Cap + +``` +optional arguments: + -M MAX_COUNTRIES_TO_DISPLAY, --max MAX_COUNTRIES_TO_DISPLAY + Maximum number of countries to display (default: 15) + -m MIN_PCT_TO_DISPLAY_COUNTRY, --min MIN_PCT_TO_DISPLAY_COUNTRY + Minimum percentage to display country (default: 0.015) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` +Feature Screenshot - cpci diff --git a/website/content/stocks/sia/cpcs/_index.md b/website/content/stocks/sia/cpcs/_index.md new file mode 100644 index 00000000000..914311fbc36 --- /dev/null +++ b/website/content/stocks/sia/cpcs/_index.md @@ -0,0 +1,18 @@ +``` +usage: cpcs [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Companies per Country based on Sector and Market Cap + +``` +optional arguments: + -M MAX_COUNTRIES_TO_DISPLAY, --max MAX_COUNTRIES_TO_DISPLAY + Maximum number of countries to display (default: 15) + -m MIN_PCT_TO_DISPLAY_COUNTRY, --min MIN_PCT_TO_DISPLAY_COUNTRY + Minimum percentage to display country (default: 0.015) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` +Feature Screenshot - cpcs diff --git a/website/content/stocks/sia/cpic/_index.md b/website/content/stocks/sia/cpic/_index.md new file mode 100644 index 00000000000..499c41616bc --- /dev/null +++ b/website/content/stocks/sia/cpic/_index.md @@ -0,0 +1,19 @@ +```text +usage: cpic [-M MAX_INDUSTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_INDUSTRY] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Companies per Industry based on Country and Market Cap + +``` +optional arguments: + -M MAX_INDUSTRIES_TO_DISPLAY, --max MAX_INDUSTRIES_TO_DISPLAY + Maximum number of industries to display (default: 15) + -m MIN_PCT_TO_DISPLAY_INDUSTRY, --min MIN_PCT_TO_DISPLAY_INDUSTRY + Minimum percentage to display industry (default: 0.015) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` + +Feature Screenshot - cpi diff --git a/website/content/stocks/sia/cpis/_index.md b/website/content/stocks/sia/cpis/_index.md new file mode 100644 index 00000000000..9db9d2bca95 --- /dev/null +++ b/website/content/stocks/sia/cpis/_index.md @@ -0,0 +1,18 @@ +```text +usage: cpis [-M MAX_INDUSTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_INDUSTRY] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Companies per Industry based on Sector and Market Cap + +``` +optional arguments: + -M MAX_INDUSTRIES_TO_DISPLAY, --max MAX_INDUSTRIES_TO_DISPLAY + Maximum number of industries to display (default: 15) + -m MIN_PCT_TO_DISPLAY_INDUSTRY, --min MIN_PCT_TO_DISPLAY_INDUSTRY + Minimum percentage to display industry (default: 0.015) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` +Feature Screenshot - cpis diff --git a/website/content/stocks/sia/cps/_index.md b/website/content/stocks/sia/cps/_index.md new file mode 100644 index 00000000000..875ea9962d9 --- /dev/null +++ b/website/content/stocks/sia/cps/_index.md @@ -0,0 +1,18 @@ +``` +usage: cps [-M MAX_SECTORS_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_SECTOR] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Companies per sector in the selected country. + +``` +optional arguments: + -M MAX_SECTORS_TO_DISPLAY, --max MAX_SECTORS_TO_DISPLAY + Maximum number of sectors to display (default: 15) + -m MIN_PCT_TO_DISPLAY_SECTOR, --min MIN_PCT_TO_DISPLAY_SECTOR + Minimum percentage to display sector (default: 0.015) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` +Feature Screenshot - spi diff --git a/website/content/stocks/sia/exchange/_index.md b/website/content/stocks/sia/exchange/_index.md new file mode 100644 index 00000000000..af43b36ad2e --- /dev/null +++ b/website/content/stocks/sia/exchange/_index.md @@ -0,0 +1,10 @@ +```text +usage: exchange [-h] +``` + +Swap the exclude international exchanges flag. + +``` +optional arguments: + -h, --help show this help message (default: False) +``` diff --git a/website/content/stocks/sia/industry/_index.md b/website/content/stocks/sia/industry/_index.md new file mode 100644 index 00000000000..e3837cadc63 --- /dev/null +++ b/website/content/stocks/sia/industry/_index.md @@ -0,0 +1,255 @@ +```text +usage: industry [-n NAME [NAME ...]] [-h] +``` + +See existing industries, or set industry if arg specified + +``` +optional arguments: + -n NAME [NAME ...], --name NAME [NAME ...] + industry to select (default: None) + -h, --help show this help message (default: False) +``` +Available Industries to select: + +``` +(✨) (stocks)>(sia)> industry + +Advertising Agencies +Aerospace & Defense +Aerospace Defense - Major Diversified +Aerospace Defense Products & Services +Agricultural Chemicals +Agricultural Inputs +Air Delivery & Freight Services +Airlines +Airports & Air Services +Aluminum +Apparel Manufacturing +Apparel Retail +Apparel Stores +Asset Management +Auto & Truck Dealerships +Auto Dealerships +Auto Manufacturers +Auto Manufacturers - Major +Auto Parts +Banks - Diversified +Banks - Regional +Beverages - Brewers +Beverages - Non-Alcoholic +Beverages - Soft Drinks +Beverages - Wineries & Distilleries +Beverages - Wineries & Distillers +Biotechnology +Broadcasting +Broadcasting - TV +Building Materials +Building Products & Equipment +Business Equipment +Business Equipment & Supplies +Business Services +Business Software & Services +Capital Markets +Chemicals +Chemicals - Major Diversified +Cigarettes +Closed-End Fund - Equity +Coking Coal +Communication Equipment +Computer Based Systems +Computer Hardware +Confectioners +Conglomerates +Consulting Services +Consumer Electronics +Copper +Credit Services +Department Stores +Diagnostics & Research +Discount Stores +Discount, Variety Stores +Diversified Computer Systems +Diversified Electronics +Diversified Investments +Diversified Machinery +Diversified Utilities +Drug Manufacturers - General +Drug Manufacturers - Major +Drug Manufacturers - Other +Drug Manufacturers - Specialty & Generic +Drugs - Generic +Education & Training Services +Electric Utilities +Electrical Equipment & Parts +Electronic Components +Electronic Equipment +Electronic Gaming & Multimedia +Electronics & Computer Distribution +Electronics Wholesale +Engineering & Construction +Entertainment +Entertainment - Diversified +Farm & Construction Machinery +Farm & Heavy Construction Machinery +Farm Products +Financial Conglomerates +Financial Data & Stock Exchanges +Food - Major Diversified +Food Distribution +Food Wholesale +Footwear & Accessories +Furnishings, Fixtures & Appliances +Gambling +Gaming Activities +General Building Materials +General Contractors +Gold +Grocery Stores +Health Care Plans +Health Information Services +Healthcare Information Services +Healthcare Plans +Heavy Construction +Home Furnishings & Fixtures +Home Improvement Retail +Hospitals +Household & Personal Products +Independent Oil & Gas +Industrial Distribution +Industrial Equipment Wholesale +Industrial Metals & Minerals +Information Technology Services +Infrastructure Operations +Insurance - Diversified +Insurance - Life +Insurance - Property & Casualty +Insurance - Reinsurance +Insurance - Specialty +Insurance Brokers +Integrated Freight & Logistics +Internet Content & Information +Internet Information Providers +Internet Retail +Internet Service Providers +Internet Software & Services +Investment Brokerage - National +Jewelry Stores +Leisure +Life Insurance +Lodging +Long Distance Carriers +Lumber & Wood Production +Lumber, Wood Production +Luxury Goods +Machine Tools & Accessories +Major Airlines +Major Integrated Oil & Gas +Marine Shipping +Marketing Services +Medical Appliances & Equipment +Medical Care Facilities +Medical Devices +Medical Distribution +Medical Instruments & Supplies +Medical Laboratories & Research +Metal Fabrication +Money Center Banks +Mortgage Finance +Mortgage Investment +Multimedia & Graphics Software +Networking & Communication Devices +Nonmetallic Mineral Mining +Oil & Gas Drilling +Oil & Gas Drilling & Exploration +Oil & Gas E&P +Oil & Gas Equipment & Services +Oil & Gas Integrated +Oil & Gas Midstream +Oil & Gas Pipelines +Oil & Gas Refining & Marketing +Other Industrial Metals & Mining +Other Precious Metals & Mining +Packaged Foods +Packaging & Containers +Paper & Paper Products +Personal Products +Personal Services +Pharmaceutical Retailers +Pollution & Treatment Controls +Printed Circuit Boards +Processed & Packaged Goods +Property & Casualty Insurance +Property Management +Publishing +Publishing - Newspapers +REIT - Diversified +REIT - Healthcare Facilities +REIT - Hotel & Motel +REIT - Industrial +REIT - Mortgage +REIT - Office +REIT - Residential +REIT - Retail +REIT - Specialty +Railroads +Real Estate - Development +Real Estate - Diversified +Real Estate Development +Real Estate Services +Recreational Goods, Other +Recreational Vehicles +Regional - Mid-Atlantic Banks +Rental & Leasing Services +Research Services +Residential Construction +Resorts & Casinos +Restaurants +Rubber & Plastics +Scientific & Technical Instruments +Security & Protection Services +Security Software & Services +Semiconductor - Broad Line +Semiconductor Equipment & Materials +Semiconductor- Memory Chips +Semiconductors +Shell Companies +Shipping +Silver +Software - Application +Software - Infrastructure +Solar +Specialized Health Services +Specialty Business Services +Specialty Chemicals +Specialty Industrial Machinery +Specialty Retail +Specialty Retail, Other +Staffing & Employment Services +Staffing & Outsourcing Services +Steel +Steel & Iron +Technical & System Software +Telecom Services +Textile - Apparel Clothing +Textile - Apparel Footwear & Accessories +Textile Industrial +Textile Manufacturing +Thermal Coal +Tobacco +Tobacco Products, Other +Tools & Accessories +Travel Services +Trucking +Trucks & Other Vehicles +Uranium +Utilities - Diversified +Utilities - Independent Power Producers +Utilities - Regulated Electric +Utilities - Regulated Gas +Utilities - Regulated Water +Utilities - Renewable +Waste Management +Water Utilities +Wireless Communications +``` diff --git a/website/content/stocks/sia/load/_index.md b/website/content/stocks/sia/load/_index.md new file mode 100644 index 00000000000..f823a5c2f29 --- /dev/null +++ b/website/content/stocks/sia/load/_index.md @@ -0,0 +1,78 @@ +```text +usage: load [-t S_TICKER] [-s S_START_DATE] [-e S_END_DATE] [-i {1,5,15,30,60}] [--source {yf,av,iex}] [-p] [-h] +``` +Load a ticker to see its industry and sector classification. + +``` +optional arguments: + -t S_TICKER, --ticker S_TICKER + Stock ticker (default: None) + -s S_START_DATE, --start S_START_DATE + The starting date (format YYYY-MM-DD) of the stock (default: 2020-12-04) + -e S_END_DATE, --end S_END_DATE + The ending date (format YYYY-MM-DD) of the stock (default: 2021-12-05) + -i {1,5,15,30,60}, --interval {1,5,15,30,60} + Intraday stock minutes (default: 1440) + --source {yf,av,iex} Source of historical data. (default: yf) + -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) + -h, --help show this help message (default: False) +``` + +Sample output: + +``` +(✨) (stocks)>(sia)> load gm +Loading Daily GM stock with starting period 2020-12-04 for analysis. + +(✨) (stocks)>(sia)> help + +Sector and Industry Analysis: + cls clear screen + ?/help show this menu again + q quit this menu, and shows back to main menu + quit quit to abandon program + load load a ticker and get its industry, sector, country and market cap + + clear clear all or one of industry, sector, country and market cap parameters + industry see existing industries, or set industry if arg specified + sector see existing sectors, or set sector if arg specified + country see existing countries, or set country if arg specified + mktcap set mktcap between small, mid or large + exchange revert exclude international exchanges flag + +Industry : Auto Manufacturers +Sector : Consumer Cyclical +Country : United States +Market Cap : Large +Exclude Exchanges : True + +Country (and Market Cap) + cpi companies per industry in country + cps companies per sector in country + +Financials + roa return on assets + roe return on equity + cr current ratio + qr quick ratio + de debt to equity + tc total cash + tcs total cash per share + tr total revenue + rps revenue per share + rg revenue growth + eg earnings growth + pm profit margins + gp gross profits + gm gross margins + ocf operating cash flow + om operating margins + fcf free cash flow + td total debt + ebitda earnings before interest, taxes, depreciation and amortization + ebitdam ebitda margins + rec recommendation mean + +Returned tickers: +> ca take these to comparison analysis menu +``` diff --git a/website/content/stocks/sia/metric/_index.md b/website/content/stocks/sia/metric/_index.md new file mode 100644 index 00000000000..189cf27e1e0 --- /dev/null +++ b/website/content/stocks/sia/metric/_index.md @@ -0,0 +1,20 @@ +```text +usage: metric [-m {roa,roe,cr,qr,de,tc,tcs,tr,rps,rg,eg,pm,gp,gm,ocf,om,fcf,td,ebitda,ebitdam,rec,mc,fte,er,bv,ss,pb,beta,fs,peg,ev,fpe}] [-l LIMIT] [-r] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] +``` + +Visualise a particular metric with the filters selected + +``` +optional arguments: + -m {roa,roe,cr,qr,de,tc,tcs,tr,rps,rg,eg,pm,gp,gm,ocf,om,fcf,td,ebitda,ebitdam,rec,mc,fte,er,bv,ss,pb,beta,fs,peg,ev,fpe}, --metric {roa,roe,cr,qr,de,tc,tcs,tr,rps,rg,eg,pm,gp,gm,ocf,om,fcf,td,ebitda,ebitdam,rec,mc,fte,er,bv,ss,pb,beta,fs,peg,ev,fpe} + Metric to visualize (default: None) + -l LIMIT, --limit LIMIT + Limit number of companies to display (default: 10) + -r, --raw Output all raw data (default: False) + -h, --help show this help message (default: False) + --export {csv,json,xlsx,png,jpg,pdf,svg} + Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) +``` + + +Feature Screenshot - metric diff --git a/website/content/stocks/sia/mktcap/_index.md b/website/content/stocks/sia/mktcap/_index.md new file mode 100644 index 00000000000..2ab62094fb5 --- /dev/null +++ b/website/content/stocks/sia/mktcap/_index.md @@ -0,0 +1,12 @@ +``` text +usage: mktcap [-n {Small,Mid,Large,small,mid,large}] [-h] +``` + +Set market cap limit to: small, mid or large. + +``` +Optional arguments: + -n {Small,Mid,Large,small,mid,large}, --name {Small,Mid,Large,small,mid,large} + market cap to select (default: None) + -h, --help show this help message (default: False) +``` diff --git a/website/content/stocks/sia/sama/_index.md b/website/content/stocks/sia/sama/_index.md new file mode 100644 index 00000000000..dc37fd81a9f --- /dev/null +++ b/website/content/stocks/sia/sama/_index.md @@ -0,0 +1,48 @@ +```text +usage: sama [-h] +``` + +See all metrics available + +``` +optional arguments: + -h, --help show this help message (default: False) +``` + +Available metrics + +``` + roa return on assets + roe return on equity + cr current ratio + qr quick ratio + de debt to equity + tc total cash + tcs total cash per share + tr total revenue + rps revenue per share + rg revenue growth + eg earnings growth + pm profit margins + gp gross profits + gm gross margins + ocf operating cash flow + om operating margins + fcf free cash flow + td total debt + ebitda earnings before interest, taxes, depreciation and amortization + ebitdam ebitda margins + rec recommendation mean + mc market cap + fte full time employees + er enterprise to revenue + bv book value + ss shares short + pb price to book + beta beta + fs float shares + sr short ratio + peg peg ratio + ev enterprise value + fpe forward P/E +``` diff --git a/website/content/stocks/sia/sector/_index.md b/website/content/stocks/sia/sector/_index.md new file mode 100644 index 00000000000..52fed5b189b --- /dev/null +++ b/website/content/stocks/sia/sector/_index.md @@ -0,0 +1,33 @@ +```text +usage: sector [-n NAME [NAME ...]] [-h] +``` + +See existing sectors, or set the sector using the -n argument. + +``` +optional arguments: + -n NAME [NAME ...], --name NAME [NAME ...] + sector to select (default: None) + -h, --help show this help message (default: False) +``` + +Available sectors: + +``` +Basic Materials +Communication Services +Conglomerates +Consumer Cyclical +Consumer Defensive +Consumer Goods +Energy +Financial +Financial Services +Healthcare +Industrial Goods +Industrials +Real Estate +Services +Technology +Utilities +``` diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index 374602d3107..5fd24721195 100755 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -54,6 +54,37 @@ main: ref: "/stocks/discovery/fds" - name: rtat ref: "/stocks/discovery/rtat" + - name: Sector and Industry Analysis (SIA) + ref: "/stocks/sia" + sub: + - name: load + ref: "/stocks/sia/load" + - name: clear + ref: "/stocks/sia/clear" + - name: industry + ref: "/stocks/sia/industry" + - name: sector + ref: "/stocks/sia/sector" + - name: country + ref: "/stocks/sia/country" + - name: mktcap + ref: "/stocks/sia/mktcap" + - name: exchange + ref: "/stocks/sia/exchange" + - name: cps + ref: "/stocks/sia/cps" + - name: cpic + ref: "/stocks/sia/cpic" + - name: cpis + ref: "/stocks/sia/cpis" + - name: cpcs + ref: "/stocks/sia/cpcs" + - name: cpci + ref: "/stocks/sia/cpci" + - name: sama + ref: "/stocks/sia/sama" + - name: metric + ref: "/stocks/sia/metric" - name: dark pool shorts ref: "/stocks/dark_pool_shorts" sub: