OpenBB/docs/code.rst

Class library and code comments
======================================

Root level files
----------------------------------

.. automodule:: gamestonk_terminal.feature_flags
   :members:
.. automodule:: gamestonk_terminal.helper_funcs
   :members:
.. automodule:: gamestonk_terminal.main_helper
   :members:
.. automodule:: gamestonk_terminal.menu
   :members:
.. automodule:: gamestonk_terminal.reddit_helpers
   :members:
.. automodule:: gamestonk_terminal.res_menu
   :members:
.. automodule:: gamestonk_terminal.test_helper
   :members:
.. automodule:: gamestonk_terminal.thought_of_the_day
   :members:
.. automodule:: gamestonk_terminal.config_neural_network_models
   :members:
.. automodule:: gamestonk_terminal.config_plot
   :members:
.. automodule:: gamestonk_terminal.config_terminal
   :members:
.. automodule:: gamestonk_terminal.dataframe_helpers
   :members:


Technical analysis
-------------------

.. automodule:: gamestonk_terminal.technical_analysis.finbrain_view
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.finviz_view
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.momentum
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.overlap
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.ta_controller
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.tradingview_view
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.trend_indicators
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.trendline_api
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.volatility
   :members:
.. automodule:: gamestonk_terminal.technical_analysis.volume
   :members:


Stock screener
--------------

.. automodule:: gamestonk_terminal.screener.finviz_view
   :members:
.. automodule:: gamestonk_terminal.screener.screener_controller
   :members:
.. automodule:: gamestonk_terminal.screener.yahoo_finance_view
   :members:


Residual analysis
-----------------

.. automodule:: gamestonk_terminal.residuals_analysis.ra_controller
   :members:
.. automodule:: gamestonk_terminal.residuals_analysis.residuals_api
   :members:
.. automodule:: gamestonk_terminal.residuals_analysis.residuals_model
   :members:


Prediction techniques
---------------------

.. automodule:: gamestonk_terminal.prediction_techniques.arima
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.ets
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.fbprophet
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.knn
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.neural_networks
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.pred_controller
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.pred_helper
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.regression
   :members:
.. automodule:: gamestonk_terminal.prediction_techniques.sma
   :members:


Portfolio optimization
----------------------

.. automodule:: gamestonk_terminal.portfolio_optimization.optimizer_helper
   :members:
.. automodule:: gamestonk_terminal.portfolio_optimization.optimizer_view
   :members:
.. automodule:: gamestonk_terminal.portfolio_optimization.po_controller
   :members:



Behavioural analysis
--------------------

.. automodule:: gamestonk_terminal.behavioural_analysis.ba_controller
   :members:
.. automodule:: gamestonk_terminal.behavioural_analysis.finbrain_view
   :members:
.. automodule:: gamestonk_terminal.behavioural_analysis.google_view
   :members:
.. automodule:: gamestonk_terminal.behavioural_analysis.reddit_view
   :members:
.. automodule:: gamestonk_terminal.behavioural_analysis.stocktwits_view
   :members:
.. automodule:: gamestonk_terminal.behavioural_analysis.twitter_view
   :members:

Comparison analysis
--------------------

.. automodule:: gamestonk_terminal.comparison_analysis.ca_controller
   :members:
.. automodule:: gamestonk_terminal.comparison_analysis.finbrain_view
   :members:
.. automodule:: gamestonk_terminal.comparison_analysis.finviz_compare_view
   :members:
.. automodule:: gamestonk_terminal.comparison_analysis.market_watch_view
   :members:
.. automodule:: gamestonk_terminal.comparison_analysis.yahoo_finance_view
   :members:


Cryptocurrency
--------------

.. automodule:: gamestonk_terminal.cryptocurrency.coinmarketcap_view
   :members:
.. automodule:: gamestonk_terminal.cryptocurrency.crypto_controller
   :members:
.. automodule:: gamestonk_terminal.cryptocurrency.crypto_helper
   :members:


Discovery
---------

.. automodule:: gamestonk_terminal.discovery.alpha_vantage_view
   :members:
.. automodule:: gamestonk_terminal.discovery.ark_model
   :members:
.. automodule:: gamestonk_terminal.discovery.ark_view
   :members:
.. automodule:: gamestonk_terminal.discovery.disc_controller
   :members:
.. automodule:: gamestonk_terminal.discovery.fidelity_model
   :members:
.. automodule:: gamestonk_terminal.discovery.fidelity_view
   :members:
.. automodule:: gamestonk_terminal.discovery.finra_ats_view
   :members:
.. automodule:: gamestonk_terminal.discovery.finviz_view
   :members:
.. automodule:: gamestonk_terminal.discovery.marketbeat_model
   :members:
.. automodule:: gamestonk_terminal.discovery.marketbeat_view
   :members:
.. automodule:: gamestonk_terminal.discovery.seeking_alpha_model
   :members:
.. automodule:: gamestonk_terminal.discovery.seeking_alpha_view
   :members:
.. automodule:: gamestonk_terminal.discovery.short_interest_model
   :members:
.. automodule:: gamestonk_terminal.discovery.short_interest_view
   :members:
.. automodule:: gamestonk_terminal.discovery.simply_wallst_view
   :members:
.. automodule:: gamestonk_terminal.discovery.spachero_view
   :members:
.. automodule:: gamestonk_terminal.discovery.unusual_whales_view
   :members:
.. automodule:: gamestonk_terminal.discovery.yahoo_finance_view
   :members:

Due diligence
-------------

.. automodule:: gamestonk_terminal.due_diligence.business_insider_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.dd_controller
   :members:
.. automodule:: gamestonk_terminal.due_diligence.financial_modeling_prep_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.finra_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.finviz_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.market_watch_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.news_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.quandl_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.reddit_view
   :members:
.. automodule:: gamestonk_terminal.due_diligence.sec_view
   :members:

Econ
-----

.. automodule:: gamestonk_terminal.econ.econ_controller
   :members:
.. automodule:: gamestonk_terminal.econ.fred_view
   :members:
.. automodule:: gamestonk_terminal.econ.vix_view
   :members:

Exploratory data analysis
-------------------------

.. automodule:: gamestonk_terminal.exploratory_data_analysis.eda_api
   :members:
.. automodule:: gamestonk_terminal.exploratory_data_analysis.eda_controller
   :members:

Forex
-----

.. automodule:: gamestonk_terminal.forex.fx_controller
   :members:
.. automodule:: gamestonk_terminal.forex.fx_view
   :members:

Fundamental analysis
--------------------

.. automodule:: gamestonk_terminal.fundamental_analysis.alpha_vantage_controller
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.alpha_vantage_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.business_insider_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.fa_controller
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.financial_modeling_prep_controller
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.financial_modeling_prep_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.finviz_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.market_watch_model
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.market_watch_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.yahoo_finance_view
   :members:
.. automodule:: gamestonk_terminal.fundamental_analysis.yield_curve_model
   :members:

Options
-------

.. automodule:: gamestonk_terminal.options.chains_view
   :members:
.. automodule:: gamestonk_terminal.options.op_controller
   :members:
.. automodule:: gamestonk_terminal.options.op_scrape_view
   :members:
.. automodule:: gamestonk_terminal.options.volume_helper
   :members:
.. automodule:: gamestonk_terminal.options.volume_view
   :members:

Papermill
---------

.. automodule:: gamestonk_terminal.papermill.due_diligence_view
   :members:
.. automodule:: gamestonk_terminal.papermill.econ_data_helper
   :members:
.. automodule:: gamestonk_terminal.papermill.econ_data_view
   :members:
.. automodule:: gamestonk_terminal.papermill.papermill_controller
   :members:

Portfolio
----------

.. automodule:: gamestonk_terminal.portfolio.ally_api
   :members:
.. automodule:: gamestonk_terminal.portfolio.alp_api
   :members:
.. automodule:: gamestonk_terminal.portfolio.dg_api
   :members:
.. automodule:: gamestonk_terminal.portfolio.port_controller
   :members:
.. automodule:: gamestonk_terminal.portfolio.portfolio_helpers
   :members:
.. automodule:: gamestonk_terminal.portfolio.rh_api
   :members: