Merge pull request #320 from DidierRLopes/improve-features-doc

2026-10-27 12:40:35 +00:00 · 2021-04-07 08:53:17 +01:00
parent 095b131ae5 5f7257e536
commit e26eebadad
8 changed files with 185 additions and 111 deletions
--- a/gamestonk_terminal/README.md
+++ b/gamestonk_terminal/README.md
@@ -10,6 +10,12 @@
 * [Prediction Techniques](#Prediction-Techniques-)
 * [Portfolio Analysis](#Portfolio-Analysis-)
 * [Cryptocurrencies](#Cryptocurrencies-)
+* [Comparison Analysis](#Comparison-Analysis-)
+* [Exploratory Data Analysis](#Exploratory-Data-Analysis-)
+* [Residual Analysis](#Residual-Analysis-)
+* [FRED](#FRED-)
+* [Options](#Options-)
+* [Screener](#Screener-)

 ## Main

@@ -56,21 +62,28 @@ export -f GNUS_data -F csv
 Command|Description|Source
 ---|---|---
 `map`           |S&P500 index stocks map |[Finviz](https://finviz.com)
-`sectors`       |show sectors performance |[Alpha Vantage](www.alphavantage.co)
+`rtp_sectors`   |real-time performance sectors |[Alpha Vantage](www.alphavantage.co)
 `gainers`       |show latest top gainers |[Yahoo Finance](https://finance.yahoo.com/)
+`losers`        |show latest top losers |[Yahoo Finance](https://finance.yahoo.com/)
 `orders`        |orders by Fidelity Customers |[Fidelity](https://www.fidelity.com/)
+`ark_orders`    |orders by ARK Investment Management LLC | [Cathiesark](https://www.cathiesark.com)
 `up_earnings`   |upcoming earnings release dates |[Seeking Alpha](https://seekingalpha.com/)
 `high_short`    |show top high short interest stocks of over 20% ratio |[High Short Interest](https://www.highshortinterest.com/)
 `low_float`     |show low float stocks under 10M shares float |[Low Float](https://www.lowfloat.com/)
 `simply_wallst` |Simply Wall St. research data |[Simply Wall St.](https://simplywall.st/about)
 `spachero`      |great website for SPACs research |[SpacHero](https://www.spachero.com/)
 `uwhales`       |good website for SPACs research |[UnusualWhales](https://unusualwhales.com/)
+`valuation`     |valuation of sectors, industry, country |[Finviz](https://finviz.com)
+`performance`   |performance of sectors, industry, country |[Finviz](https://finviz.com)
+`spectrum`      |spectrum of sectors, industry, country |[Finviz](https://finviz.com)

 &nbsp;

 ## Behavioural Analysis [»](behavioural_analysis/README.md)
 Command|Description
 ----|----
+[FinBrain](https://finbrain.tech)|
+`finbrain`      |sentiment from 15+ major news headlines
 [Reddit](https://reddit.com)|
 `wsb`           |show what WSB gang is up to in subreddit wallstreetbets
 `watchlist`     |show other users watchlist
@@ -113,6 +126,7 @@ Command|Website
 `zacks`             |www.zacks.com
 `macrotrends`       |www.macrotrends.net
 `newsfilter`        |www.newsfilter.io
+`stockanalysis`     |www.stockanalysis.com
 `resources`         |www.tradinganalysisresources.com

 &nbsp;
@@ -125,11 +139,8 @@ Command|Description
 `mgmt`          |management team of the company ([Business Insider](https://markets.businessinsider.com/))
 [Market Watch API](https://markets.businessinsider.com/) |
 `income`        |income statement of the company
-`assets`        |assets of the company
-`liabilities`   |liabilities and shareholders equity of the company
-`operating`     |cash flow operating activities of the company
-`investing`     |cash flow investing activities of the company
-`financing`     |cash flow financing activities of the company
+`balance`       |balance sheet of the company
+`cash`          |cash flow statement of the company
 [Yahoo Finance API](https://finance.yahoo.com/) |
 `info`          |information scope of the company
 `shrs`          |shareholders of the company
@@ -146,9 +157,9 @@ Command|Description
 `quote`         |quote of the company
 `enterprise`    |enterprise value of the company over time
 `dcf`           |discounted cash flow of the company over time
-`inc`           |income statements of the company
-`bal`           |balance sheet of the company
-`cashf`         |cash flow of the company
+`income`        |income statements of the company
+`balance`       |balance sheet of the company
+`cash`          |cash flow of the company
 `metrics`       |key metrics of the company
 `ratios`        |financial ratios of the company
 `growth`        |financial statement growth of the company
@@ -158,6 +169,9 @@ Command|Description
 ## Technical Analysis [»](technical_analysis/README.md)
 Command | Description | Sources
 ------ | ------ | ------
+`view`         | view historical data and trendlines| [Finviz](https://finviz.com/quote.ashx?t=tsla)
+`summary`      | technical summary report| [FinBrain](https://finbrain.tech)
+`recom`        | recommendation based on Technical Indicators| [Tradingview](https://uk.tradingview.com/widget/technical-analysis/)
 [overlap](https://github.com/twopirllc/pandas-ta/tree/master/pandas_ta/overlap) |
 `ema`         | exponential moving average | [Wikipedia](https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average), [Investopedia](https://www.investopedia.com/terms/e/ema.asp)
 `sma`         |simple moving average | [Wikipedia](https://en.wikipedia.org/wiki/Moving_average#Simple_moving_average_(boxcar_filter)), [Investopedia](https://www.investopedia.com/terms/s/sma.asp)
@@ -179,7 +193,7 @@ Command | Description | Sources
 &nbsp;

 ## Due Diligence [»](due_diligence/README.md)
-Command|Explanation|Source
+Command|Description|Source
 ------ | --------|----
 `news`          |latest news of the company |[Finviz](https://finviz.com/)
 `red`           |gets due diligence from another user's post |[Reddit](https://reddit.com)
@@ -213,20 +227,110 @@ Command|Technique|Sources
 &nbsp;
 ## Portfolio Analysis [»](portfolio/README.md)

-Command|Description
------ | ------------
-`login`| login to desired brokers
-`rhhold`| look at robinhood holdings
-`rhhist`| look at robinhood portfolio history
-`alphold`| look at alpaca holdings
-`alphist`| look at alpaca portfolio history
-`allyhold`| look at ally holdings
-`hold`| look at holdings across all brokers for which you have logged in
+Command|Description|Brokers
+------ | ------------|---
+`login`   | login to your brokers
+`rhhold`  | view robinhood holdings | [Robinhood](https://robinhood.com/us/en/)
+`rhhist`  | plot robinhood portfolio history | [Robinhood](https://robinhood.com/us/en/)
+`alphold` | view alpaca holdings | [Alpaca](https://app.alpaca.markets/login)
+`alphist` | view alpaca portfolio history | [Alpaca](https://app.alpaca.markets/login)
+`allyhold`| view ally holdings | [Ally](https://www.ally.com/invest/)
+`hold`    | view net holdings across all logins

 &nbsp;
 ## Cryptocurrency [»](cryptocurrency/README.md)

 Command|Description
 ------ | ------------
-`load`| load coin data vs specified currency
-`view`| plot the loaded coin data
+`load`| load cryptocurrency data
+`view`| load and view cryptocurrency data
+
+&nbsp;
+## Comparison Analysis [»](comparison_analysis/README.md)
+Command|Description|Source
+------ | --------|----
+`get`           |get similar companies |[Polygon](https://polygon.io)
+`select`        |select similar companies
+`historical`    |historical price data comparison |[Yahoo Finance](https://finance.yahoo.com/)
+`hcorr`         |historical price correlation |[Yahoo Finance](https://finance.yahoo.com/)
+`income`        |income financials comparison |[MarketWatch](https://www.marketwatch.com/)
+`balance`       |balance financials comparison |[MarketWatch](https://www.marketwatch.com/)
+`cashflow`      |cashflow comparison |[MarketWatch](https://www.marketwatch.com/)
+`sentiment`     |sentiment analysis comparison |[FinBrain](https://finbrain.tech)
+`scorr`         |sentiment correlation |[FinBrain](https://finbrain.tech)
+
+&nbsp;
+
+## Exploratory Data Analysis [»](exploratory_data_analysis/README.md)
+Command|Description|Source
+------ | --------|----
+`get`           |get similar companies |[Polygon](https://polygon.io)
+`select`        |select similar companies
+`historical`    |historical price data comparison |[Yahoo Finance](https://finance.yahoo.com/)
+`hcorr`         |historical price correlation |[Yahoo Finance](https://finance.yahoo.com/)
+`income`        |income financials comparison |[MarketWatch](https://www.marketwatch.com/)
+`balance`       |balance financials comparison |[MarketWatch](https://www.marketwatch.com/)
+`cashflow`      |cashflow comparison |[MarketWatch](https://www.marketwatch.com/)
+`sentiment`     |sentiment analysis comparison |[FinBrain](https://finbrain.tech)
+`scorr`         |sentiment correlation |[FinBrain](https://finbrain.tech)
+
+&nbsp;
+
+## Residual Analysis [»](residual_analysis/README.md)
+Command|Description|Source
+------ | --------|----
+`pick`          |pick one of the model fitting | Supports [ARIMA](https://en.wikipedia.org/wiki/Autoregressive_integrated_moving_average), [Naive](https://en.wikipedia.org/wiki/Forecasting#Naïve_approach)
+`fit`           |show model fit against stock | [Wikipedia](https://en.wikipedia.org/wiki/Curve_fitting)
+`res`           |show residuals | [Wikipedia](https://en.wikipedia.org/wiki/Errors_and_residuals)
+`hist`          |histogram and density plot | [Wikipedia](https://en.wikipedia.org/wiki/Histogram)
+`qqplot`        |residuals against standard normal curve | [Wikipedia](https://en.wikipedia.org/wiki/Q–Q_plot)
+`acf`           |(partial) auto-correlation function | [Wikipedia](https://en.wikipedia.org/wiki/Autocorrelation)
+`normality`     |normality test (Kurtosis,Skewness,...) | [Wikipedia](https://en.wikipedia.org/wiki/Normality_test)
+`goodness`      |goodness of fit test (Kolmogorov-Smirnov) | [Wikipedia](https://en.wikipedia.org/wiki/Goodness_of_fit)
+`arch`          |autoregressive conditional heteroscedasticity | [Wikipedia](https://en.wikipedia.org/wiki/Autoregressive_conditional_heteroskedasticity)
+`unitroot`      |unit root test / stationarity (ADF, KPSS) | [Wikipedia](https://en.wikipedia.org/wiki/Unit_root_test)
+`independence`  |tests independent and identically distributed (BDS) | [Wikipedia](https://en.wikipedia.org/wiki/Pearson%27s_chi-squared_test#Testing_for_statistical_independence)
+
+&nbsp;
+## FRED [»](fred/README.md)
+Command|Description
+------ | --------
+`gdp`           | GDP
+`unemp`         | Unemployment Rate
+`t1`            | 1-Year Treasury Constant Maturity Rate
+`t5`            | 5-Year Treasury Constant Maturity Rate
+`t10`           | 10-Year Treasury Constant Maturity Rate
+`t30`           | 30-Year Treasury Constant Maturity Rate
+`mort30`        | 30-Year Fixed Rate Mortgage Average
+`fedrate`       | Effective Federal Funds Rate
+`moodAAA`       | Moody's Seasoned AAA Corporate Bond Yield
+`usdcad`        | Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
+`cust`          | User Specified FRED Data - Please Specify --id
+
+&nbsp;
+
+## Options [»](options/README.md)
+Command|Description|Source
+------ | --------|----
+`exp`           | see/set expiry date
+`volume`        | plot options trading volume / open interest |[Yahoo Finance](https://finance.yahoo.com/)
+
+&nbsp;
+
+## Screener [»](screener/README.md)
+Command|Description|Source
+------ | --------|----
+view           |view available presets | [presets]((screener/presets/README.md))
+set            |set one of the available presets
+historical     |view historical price |[Yahoo Finance](https://finance.yahoo.com/)
+[Finviz](https://finviz.com/screener.ashx) |
+overview       |overview (e.g. Sector, Industry, Market Cap, Volume)
+valuation      |valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y)
+financial      |financial (e.g. Dividend, ROA, ROE, ROI, Earnings)
+ownership      |ownership (e.g. Float, Insider Own, Short Ratio)
+performance    |performance (e.g. Perf Week, Perf YTD, Volatility M)
+technical      |technical (e.g. Beta, SMA50, 52W Low, RSI, Change)
+signals        |view filter signals (e.g. -s top_gainers)
+
+
+&nbsp;
--- a/gamestonk_terminal/cryptocurrency/crypto_controller.py
+++ b/gamestonk_terminal/cryptocurrency/crypto_controller.py
@@ -29,7 +29,7 @@ class CryptoController:
        print("   help          show this menu again")
        print("   q             quit this menu, and shows back to main menu")
        print("   quit          quit to abandon program")
-        print(f"\nCurrent Coin : {current_coin}")
+        print(f"\nCurrent Coin: {current_coin}")
        print("")
        print("   load          load cryptocurrency data")
        print("   view          load and view cryptocurrency data")
--- a/gamestonk_terminal/fundamental_analysis/README.md
+++ b/gamestonk_terminal/fundamental_analysis/README.md
@@ -11,16 +11,10 @@ This menu aims to extract all fundamentals of a pre-loaded company, and the usag

 * [income](#income)
  * income statement of the company
-* [assets](#assets)
-  * assets of the company
-* [liabilities](#liabilities)
-  * liabilities and shareholders equity of the company
-* [operating](#operating)
-  * cash flow operating activities of the company
-* [investing](#investing)
-  * cash flow investing activities of the company
-* [financing](#financing)
-  * cash flow financing activities of the company
+* [balance](#balance)
+  * balance sheet of the company
+* [cash](#cash)
+  * cash flow statement of the company

 [YAHOO FINANCE](#YAHOO_FINANCE)

@@ -99,55 +93,32 @@ Prints either yearly or quarterly income statement the company. The following fi

 * q : Quarter fundamental data flag. Default False.

-### assets <a name="assets"></a>
+### balance <a name="balance"></a>

 ```text
 usage: assets [-q]
 ```

-Prints either yearly or quarterly assets from balance sheet of the company. The following fields are expected: Cash & Short Term Investments, Cash & Short Term Investments Growth, Cash Only, Short-Term Investments, Cash & ST Investments / Total Assets, Total Accounts Receivable, Total Accounts Receivable Growth, Accounts Receivables, Net, Accounts Receivables, Gross,  Bad Debt/Doubtful Accounts, Other Receivable, Accounts Receivable Turnover, Inventories, Finished Goods, Work in Progress, Raw Materials, Progress Payments & Other, Other Current Assets, Miscellaneous Current Assets, Net Property, Plant & Equipment, Property, Plant & Equipment - Gross, Buildings, Land & Improvements, Computer Software and Equipment, Other Property, Plant & Equipment, Accumulated Depreciation, Total Investments and Advances, Other Long-Term Investments, Long-Term Note Receivables, Intangible Assets, Net Goodwill, Net Other Intangibles, Other Assets. [Source: Market Watch]
+Prints either yearly or quarterly assets from balance sheet of the company. The following fields are expected: Cash & Short Term Investments, Cash & Short Term Investments Growth, Cash Only, Short-Term Investments, Cash & ST Investments / Total Assets, Total Accounts Receivable, Total Accounts Receivable Growth, Accounts Receivables, Net, Accounts Receivables, Gross, Bad Debt/Doubtful Accounts, Other Receivable, Accounts Receivable Turnover, Inventories, Finished Goods, Work in Progress, Raw Materials, Progress Payments & Other, Other Current Assets, Miscellaneous Current Assets, Net Property, Plant & Equipment, Property, Plant & Equipment - Gross, Buildings, Land & Improvements, Computer Software and Equipment, Other Property, Plant & Equipment, Accumulated Depreciation, Total Investments and Advances, Other Long-Term Investments, Long-Term Note Receivables, Intangible Assets, Net Goodwill, Net Other Intangibles, Other Assets.
+
+Prints either yearly or quarterly liabilities and shareholders' equity from balance sheet of the company. The following fields are expected: ST Debt & Current Portion LT Debt, Short Term Debt, Current Portion of Long Term Debt, Accounts Payable, Accounts Payable Growth, Income Tax Payable, Other Current Liabilities, Dividends Payable, Accrued Payroll, Miscellaneous Current Liabilities, Long-Term Debt, Long-Term Debt excl. Capitalized Leases, Non-Convertible Debt, Convertible Debt, Capitalized Lease Obligations, Provision for Risks & Charges, Deferred Taxes, Deferred Taxes - Credits, Deferred Taxes - Debit, Other Liabilities, Other Liabilities (excl. Deferred Income), Deferred Income, Non-Equity Reserves, Total Liabilities / Total Assets, Preferred Stock (Carrying Value), Redeemable Preferred Stock, Non-Redeemable Preferred Stock, Common Equity (Total), Common Equity/Total Assets, Common Stock Par/Carry Value, Retained Earnings, ESOP Debt Guarantee, Cumulative Translation Adjustment/Unrealized For. Exch. Gain, Unrealized Gain/Loss Marketable Securities, Revaluation Reserves, Treasury Stock, Total Shareholders' Equity, Total Shareholders' Equity / Total Assets, Accumulated Minority Interest, Total Equity, Total Current Assets, Total Assets, Total Current Liabilities, Total Liabilities, and Liabilities & Shareholders' Equity. [Source: Market Watch]

 * q : Quarter fundamental data flag. Default False.

-### liabilities <a name="liabilities"></a>
+### cash <a name="cash"></a>

 ```text
-usage: liabilities [-q]
+usage: cash [-q]
 ```

-Prints either yearly or quarterly liablities and shareholders' equity from balance sheet of the company. The following fields are expected: ST Debt & Current Portion LT Debt, Short Term Debt, Current Portion of Long Term Debt, Accounts Payable, Accounts Payable Growth, Income Tax Payable, Other Current Liabilities, Dividends Payable, Accrued Payroll, Miscellaneous Current Liabilities, Long-Term Debt, Long-Term Debt excl. Capitalized Leases, Non-Convertible Debt, Convertible Debt, Capitalized Lease Obligations, Provision for Risks & Charges, Deferred Taxes, Deferred Taxes - Credits, Deferred Taxes - Debit, Other Liabilities, Other Liabilities (excl. Deferred Income), Deferred Income, Non-Equity Reserves, Total Liabilities / Total Assets, Preferred Stock (Carrying Value), Redeemable Preferred Stock, Non-Redeemable Preferred Stock, Common Equity (Total), Common Equity/Total Assets, Common Stock Par/Carry Value, Retained Earnings, ESOP Debt Guarantee, Cumulative Translation Adjustment/Unrealized For. Exch. Gain, Unrealized Gain/Loss Marketable Securities, Revaluation Reserves, Treasury Stock, Total Shareholders' Equity, Total Shareholders' Equity / Total Assets, Accumulated Minority Interest, Total Equity, Total Current Assets, Total Assets, Total Current Liabilities, Total Liabilities, and Liabilities & Shareholders' Equity. [Source: Market Watch]
+Prints either yearly or quarterly cash flow operating activities of the company. The following fields are expected: Net Income before Extraordinaries, Net Income Growth, Depreciation, Depletion & Amortization, Depreciation and Depletion, Amortization of Intangible Assets, Deferred Taxes & Investment Tax Credit, Deferred Taxes, Investment Tax Credit, Other Funds, Funds from Operations, Extraordinaries, Changes in Working Capital, Receivables, Accounts Payable, Other Assets/Liabilities, and Net Operating Cash Flow Growth.
+            
+Prints either yearly or quarterly cash flow investing activities of the company. The following fields are expected: Capital Expenditures, Capital Expenditures Growth, Capital Expenditures/Sales, Capital Expenditures (Fixed Assets), Capital Expenditures (Other Assets), Net Assets from Acquisitions, Sale of Fixed Assets & Businesses, Purchase/Sale of Investments, Purchase of Investments, Sale/Maturity of Investments, Other Uses, Other Sources, Net Investing Cash Flow Growth.
+            
+Prints either yearly or quarterly cash flow financing activities of the company. The following fields are expected: Cash Dividends Paid - Total, Common Dividends, Preferred Dividends, Change in Capital Stock, Repurchase of Common & Preferred Stk., Sale of Common & Preferred Stock, Proceeds from Stock Options, Other Proceeds from Sale of Stock, Issuance/Reduction of Debt, Net, Change in Current Debt, Change in Long-Term Debt, Issuance of Long-Term Debt, Reduction in Long-Term Debt, Other Funds, Other Uses, Other Sources, Net Financing Cash Flow Growth, Net Financing Cash Flow/Sales, Exchange Rate Effect, Miscellaneous Funds, Net Change in Cash, Free Cash Flow, Free Cash Flow Growth, Free Cash Flow Yield, Net Operating Cash Flow, Net Investing Cash Flow, Net Financing Cash Flow. [Source: Market Watch]

 * q : Quarter fundamental data flag. Default False.

-### operating <a name="operating"></a>
-
-```text
-usage: operating [-q]
-```
-
-Prints either yearly or quarterly cash flow operating activities of the company. The following fields are expected: Net Income before Extraordinaries, Net Income Growth, Depreciation, Depletion & Amortization, Depreciation and Depletion, Amortization of Intangible Assets, Deferred Taxes & Investment Tax Credit, Deferred Taxes, Investment Tax Credit, Other Funds, Funds from Operations, Extraordinaries, Changes in Working Capital, Receivables, Accounts Payable, Other Assets/Liabilities, and Net Operating Cash Flow Growth. [Source: Market Watch]
-
-* q : Quarter fundamental data flag. Default False.
-
-### investing <a name="investing"></a>
-
-```text
-usage: investing [-q]
-```
-
-Prints either yearly or quarterly cash flow investing activities of the company. The following fields are expected: Capital Expenditures, Capital Expenditures Growth, Capital Expenditures/Sales, Capital Expenditures (Fixed Assets), Capital Expenditures (Other Assets), Net Assets from Acquisitions, Sale of Fixed Assets & Businesses, Purchase/Sale of Investments, Purchase of Investments, Sale/Maturity of Investments, Other Uses, Other Sources, Net Investing Cash Flow Growth. [Source: Market Watch]
-
-* q : Quarter fundamental data flag. Default False.
-
-### financing <a name="financing"></a>
-
-```text
-usage: financing [-q]
-```
-
-Prints either yearly or quarterly cash flow financing activities of the company. The following fields are expected: Cash Dividends Paid - Total, Common Dividends, Preferred Dividends, Change in Capital Stock, Repurchase of Common & Preferred Stk., Sale of Common & Preferred Stock, Proceeds from Stock Options, Other Proceeds from Sale of Stock, Issuance/Reduction of Debt, Net, Change in Current Debt, Change in Long-Term Debt, Issuance of Long-Term Debt, Reduction in Long-Term Debt, Other Funds, Other Uses, Other Sources, Net Financing Cash Flow Growth, Net Financing Cash Flow/Sales, Exchange Rate Effect, Miscellaneous Funds, Net Change in Cash, Free Cash Flow, Free Cash Flow Growth, Free Cash Flow Yield, Net Operating Cash Flow, Net Investing Cash Flow, Net Financing Cash Flow [Source: Market Watch]
-
-* q : Quarter fundamental data flag. Default False.

 ## YAHOO FINANCE <a name="YAHOO_FINANCE"></a>

--- a/gamestonk_terminal/fundamental_analysis/market_watch_api.py
+++ b/gamestonk_terminal/fundamental_analysis/market_watch_api.py
@@ -154,12 +154,14 @@ def cash(l_args, s_ticker):
            Taxes, Investment Tax Credit, Other Funds, Funds from Operations, Extraordinaries,
            Changes in Working Capital, Receivables, Accounts Payable, Other Assets/Liabilities,
            and Net Operating Cash Flow Growth.
+
            Prints either yearly or quarterly cash flow investing activities of the company.
            The following fields are expected: Capital Expenditures, Capital Expenditures Growth,
            Capital Expenditures/Sales, Capital Expenditures (Fixed Assets), Capital Expenditures
            (Other Assets), Net Assets from Acquisitions, Sale of Fixed Assets & Businesses,
            Purchase/Sale of Investments, Purchase of Investments, Sale/Maturity of Investments,
            Other Uses, Other Sources, Net Investing Cash Flow Growth.
+
            Prints either yearly or quarterly cash flow financing activities of the company.
            The following fields are expected: Cash Dividends Paid - Total, Common Dividends,
            Preferred Dividends, Change in Capital Stock, Repurchase of Common & Preferred Stk.,
--- a/gamestonk_terminal/portfolio/port_controller.py
+++ b/gamestonk_terminal/portfolio/port_controller.py
@@ -45,31 +45,32 @@ class PortfolioController:
    def print_help(broker_list):

        """ Print help """
+        print("\nBrokers Supported: rh   - Robinhood")
+        print("                   alp  - Alpaca")
+        print("                   ally - Ally Invest")
        print("\nPortfolio:")
        print("   help          show this menu again")
        print(
            "   q             quit this menu, and shows back to main menu, logs out of brokers"
        )
        print("   quit          quit to abandon program, logs out of brokers")
-        print("   login         login to your brokers")
+
        print(
-            f"\nCurrent Brokers : {('None', ', '.join(broker_list))[bool(broker_list)]}"
+            f"\nCurrent Broker: {('None', ', '.join(broker_list))[bool(broker_list)]}"
        )
-        print("\nCurrently Supported :")
-        print("   rh             Robinhood")
-        print("   alp            Alpaca")
-        print("   ally           Ally Invest")
-        print("\nCommands (login required):")
+        print("")
+        print("   login         login to your brokers")
+
        print("\nRobinhood:")
-        print("   rhhold         view rh holdings")
-        print("   rhhist         plot rh portfolio history")
-        print("\nAlpaca:")
-        print("   alphold        view alp holdings")
-        print("   alphist        view alp portfolio history")
-        print("\nAlly:")
-        print("   allyhold       view ally holdings")
+        print("   rhhold        view rh holdings")
+        print("   rhhist        plot rh portfolio history")
+        print("Alpaca:")
+        print("   alphold       view alp holdings")
+        print("   alphist       view alp portfolio history")
+        print("Ally:")
+        print("   allyhold      view ally holdings")
        print("\nMerge:")
-        print("   hold           view net holdings across all logins")
+        print("   hold          view net holdings across all logins")
        print("")

    def print_portfolio_menu(self):
--- a/gamestonk_terminal/residuals_analysis/ra_controller.py
+++ b/gamestonk_terminal/residuals_analysis/ra_controller.py
@@ -87,7 +87,7 @@ class ResidualsController:
            print("   normality     normality test (Kurtosis,Skewness,...)")
            print("   goodness      goodness of fit test (Kolmogorov-Smirnov)")
            print("   arch          autoregressive conditional heteroscedasticity")
-            print("   unitroot      Unit root test / stationarity (ADF, KPSS)")
+            print("   unitroot      unit root test / stationarity (ADF, KPSS)")
            print(
                "   independence  tests independent and identically distributed (BDS)"
            )
--- a/gamestonk_terminal/screener/README.md
+++ b/gamestonk_terminal/screener/README.md
@@ -9,17 +9,17 @@ This menu aims to filter stocks based on pre-specified preset filters, and the u
 * [historical](#historical)
  * view historical price [Yahoo Finance]
 * [overview](#overview)
-  * overview information [Finviz]
+  * overview (e.g. Sector, Industry, Market Cap, Volume) [Finviz]
 * [valuation](#valuation)
-  * valuation information [Finviz]
+  * valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y) [Finviz]
 * [financial](#financial)
-  * financial information [Finviz]
+  * financial (e.g. Dividend, ROA, ROE, ROI, Earnings) [Finviz]
 * [ownership](#ownership)
-  * ownership information [Finviz]
+  * ownership (e.g. Float, Insider Own, Short Ratio) [Finviz]
 * [performance](#performance)
-  * performance information [Finviz]
+  * performance (e.g. Perf Week, Perf YTD, Volatility M) [Finviz]
 * [technical](#technical)
-  * technical information [Finviz]
+  * technical (e.g. Beta, SMA50, 52W Low, RSI, Change) [Finviz]
  * contains [Oversold (-s) signal example](#signal-oversold)
 * [signals](#signals)
  * view filter signals (e.g. -s top_gainers) [Finviz]
@@ -50,7 +50,7 @@ Set preset from under presets folder.
 ## historical <a name="historical"></a>

 ```text
-usage: historical [-t {o,h,l,c,a}] [-s {top_gainers,top_losers,...}] [--start START] 
+usage: historical [-t {o,h,l,c,a}] [-s {top_gainers,top_losers,...}] [--start START]
 ```

 View historical price of stocks. [Source: Yahoo Finance]
@@ -67,10 +67,10 @@ View historical price of stocks. [Source: Yahoo Finance]
 ## overview <a name="overview"></a>

 ```text
-usage: overview [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: overview [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Sector, Industry, Market Cap, Volume. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -83,10 +83,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field
 ## valuation <a name="valuation"></a>

 ```text
-usage: valuation [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: valuation [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: P/E, PEG, P/S, P/B, EPS this Y. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -99,10 +99,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field
 ## financial <a name="financial"></a>

 ```text
-usage: financial [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: financial [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Dividend, ROA, ROE, ROI, Earnings. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -115,10 +115,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field
 ## ownership <a name="ownership"></a>

 ```text
-usage: ownership [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: ownership [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Float, Insider Own, Short Ratio. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -131,10 +131,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field
 ## performance <a name="performance"></a>

 ```text
-usage: performance [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: performance [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Perf Week, Perf YTD, Volatility M. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -147,11 +147,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field
 ## technical <a name="technical"></a>

 ```text
-usage: technical [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] 
+usage: technical [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a]
 ```

-Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial,
-ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]
+Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Beta, SMA50, 52W Low, RSI, Change. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz]

 * -p : Filter presets. Default: one pre-loaded in screener menu.
 * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded.
@@ -181,6 +180,3 @@ Prints list of available signals. [Source: Finviz]

 <img width="937" alt="Captura de ecrã 2021-04-05, às 20 25 13" src="https://user-images.githubusercontent.com/25267873/113616495-0ece9580-964d-11eb-97af-4150f928a170.png">

-
-
-
--- a/gamestonk_terminal/screener/screener_controller.py
+++ b/gamestonk_terminal/screener/screener_controller.py
@@ -60,12 +60,12 @@ class ScreenerController:
        print(f"PRESET: {self.preset}")
        print("")
        print("   historical     view historical price")
-        print("   overview       overview information")
-        print("   valuation      valuation information")
-        print("   financial      financial information")
-        print("   ownership      ownership information")
-        print("   performance    performance information")
-        print("   technical      technical information")
+        print("   overview       overview (e.g. Sector, Industry, Market Cap, Volume)")
+        print("   valuation      valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y)")
+        print("   financial      financial (e.g. Dividend, ROA, ROE, ROI, Earnings)")
+        print("   ownership      ownership (e.g. Float, Insider Own, Short Ratio)")
+        print("   performance    performance (e.g. Perf Week, Perf YTD, Volatility M)")
+        print("   technical      technical (e.g. Beta, SMA50, 52W Low, RSI, Change)")
        print("")
        print("   signals        view filter signals (e.g. -s top_gainers)")
        print("")