sqa 0.0.31 → 0.0.37

data/lib/sqa.rb

@@ -1,7 +1,8 @@
 # lib/sqa.rb
 # frozen_string_literal: true
 
-# TODO: Create a new gem for the dumbstockapi website
+# NOTE: The dumbstockapi integration is handled by SQA::Ticker class.
+# A separate gem could be created if more extensive API coverage is needed.
 
 #############################################
 ## Standard Libraries
@@ -13,20 +14,27 @@ unless defined?(HOME)
 	HOME = Pathname.new(ENV['HOME'])
 end
 
-# TODO: do we want to move the debug_me gem out of the
-# 			development dependencies into the required?
-#
+# NOTE: debug_me is optional - loaded if available, otherwise a no-op is defined.
+# This keeps it as a development dependency while allowing production use if installed.
 if defined?(DebugMe)
 	unless respond_to?(:debug_me)
 		include DebugMe
 	end
+	$DEBUG_ME = true
 else
-	require 'debug_me'
-	include DebugMe
+	begin
+		require 'debug_me'
+		include DebugMe
+		$DEBUG_ME = true
+	rescue LoadError
+		# debug_me is optional - define a no-op if not available
+		def debug_me(tag = nil, &block)
+			# No-op when debug_me gem is not available
+		end
+		$DEBUG_ME = false
+	end
 end
 
-$DEBUG_ME = true
-
 #############################################
 ## Additional Libraries
 

data/mkdocs.yml

@@ -3,7 +3,7 @@ site_name: SQA - Simple Qualitative Analysis
 site_description: A powerful Ruby library for stock market technical analysis and trading strategy development
 site_author: Dewayne VanHoozer
 site_url: https://madbomber.github.io/sqa
-copyright: Copyright © 2024 Dewayne VanHoozer
+copyright: Copyright © 2025 Dewayne VanHoozer (CAUTION! This documentation was mostly written by a robot so it might be wrong.)
 
 # Repository information
 repo_name: madbomber/sqa
@@ -56,7 +56,6 @@ theme:
 
     # Table of contents
     - toc.follow
-    - toc.integrate
 
     # Search
     - search.suggest
@@ -74,15 +73,11 @@ theme:
     - content.action.edit
     - content.action.view
 
-    # Announce
-    - announce.dismiss
-
 # Plugins
 plugins:
   - search:
       separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
-  - tags:
-      tags_file: tags.md
+  - tags
 
 # Extensions
 markdown_extensions:
@@ -97,7 +92,6 @@ markdown_extensions:
   - toc:
       permalink: true
       title: On this page
-      toc_depth: 3
 
   # Python Markdown Extensions
   - pymdownx.arithmatex:
@@ -154,9 +148,6 @@ extra:
       link: https://rubygems.org/gems/sqa
       name: SQA on RubyGems
 
-  version:
-    provider: mike
-
   analytics:
     feedback:
       title: Was this page helpful?
@@ -175,114 +166,74 @@ extra:
 # Navigation
 nav:
   - Home: index.md
-  - Getting Started:
-    - getting-started/index.md
-    - Installation: getting-started/installation.md
-    - Quick Start: getting-started/quick-start.md
-    - Configuration: getting-started/configuration.md
-    - Console Usage: getting-started/console-usage.md
-
-  - Core Concepts:
-    - concepts/index.md
-    - Stock Objects: concepts/stock.md
-    - DataFrames: data_frame.md
-    - Technical Indicators: concepts/indicators.md
-    - Trading Strategies: strategy.md
-
-  - Technical Indicators:
-    - indicators/index.md
-    - Overview: indicators.md
-    - Moving Averages:
-      - Simple Moving Average: simple_moving_average.md
-      - Exponential Moving Average: exponential_moving_average.md
-      - Weighted Moving Average: weighted_moving_average.md
-    - Momentum Indicators:
-      - RSI (Relative Strength Index): relative_strength_index.md
-      - Momentum: momentum.md
-      - Stochastic Oscillator: stochastic_oscillator.md
-      - True Strength Index: true_strength_index.md
-    - Volatility Indicators:
-      - Bollinger Bands: bollinger_bands.md
-      - Average True Range: average_true_range.md
-      - True Range: true_range.md
-      - Donchian Channel: donchian_channel.md
-    - Trend Indicators:
-      - MACD: moving_average_convergence_divergence.md
-      - Market Profile: market_profile.md
-    - Pattern Recognition:
-      - Fibonacci Retracement: fibonacci_retracement.md
-      - Peaks and Valleys: peaks_and_valleys.md
-      - Candlestick Patterns: candlestick_pattern_recognizer.md
-      - Double Top/Bottom: double_top_bottom_pattern.md
-      - Head and Shoulders: head_and_shoulders_pattern.md
 
-  - Trading Strategies:
-    - strategies/index.md
-    - Built-in Strategies:
-      - Bollinger Bands Strategy: strategies/bollinger-bands.md
-      - RSI Strategy: strategies/rsi.md
-      - MACD Strategy: strategies/macd.md
-      - SMA Strategy: strategies/sma.md
-      - EMA Strategy: strategies/ema.md
-      - Stochastic Strategy: strategies/stochastic.md
-      - Volume Breakout: strategies/volume-breakout.md
-      - Mean Reversion: strategies/mean-reversion.md
-      - Market Profile: strategies/market-profile.md
-      - Consensus Strategy: strategies/consensus.md
-    - Advanced Strategies:
-      - Knowledge-Based Strategy (KBS): strategies/kbs.md
-      - Custom Strategies: strategies/custom.md
-
-  - Advanced Features:
-    - advanced/index.md
-    - Portfolio Management: advanced/portfolio.md
-    - Backtesting: advanced/backtesting.md
-    - Strategy Generator: advanced/strategy-generator.md
-    - Genetic Programming: genetic_programming.md
-    - Real-Time Streaming: advanced/streaming.md
-    - FPOP Analysis: advanced/fpop.md
-    - Risk Management: advanced/risk-management.md
-    - Portfolio Optimizer: advanced/portfolio-optimizer.md
-    - Ensemble Strategies: advanced/ensemble.md
-    - Multi-Timeframe Analysis: advanced/multi-timeframe.md
-    - Pattern Matcher: advanced/pattern-matcher.md
-
-  - AI & Machine Learning:
-    - ai_and_ml.md
-    - Predict Next Value: predict_next_value.md
-    - Identify Wave Condition: identify_wave_condition.md
-    - LIBSVM Format: libsvm_file_format.md
+  - Getting Started:
+      - Overview: getting-started/index.md
+      - Installation: getting-started/installation.md
+      - Quick Start: getting-started/quick-start.md
+
+  - User Guide:
+      - Core Concepts:
+          - Overview: concepts/index.md
+          - DataFrames: data_frame.md
+          - Trading Strategies: strategy.md
+      - Technical Indicators:
+          - Overview: indicators/index.md
+          - Indicator Details: indicators.md
+          - sqa-tai Gem: https://github.com/MadBomber/sqa-tai
+          - TA-Lib Documentation: https://ta-lib.org/
+      - Trading Strategies:
+          - Overview: strategies/index.md
+          - Built-in Strategies:
+              - Bollinger Bands: strategies/bollinger-bands.md
+              - RSI Strategy: strategies/rsi.md
+              - MACD Strategy: strategies/macd.md
+              - SMA Strategy: strategies/sma.md
+              - EMA Strategy: strategies/ema.md
+              - Stochastic: strategies/stochastic.md
+              - Volume Breakout: strategies/volume-breakout.md
+              - Mean Reversion: strategies/mean-reversion.md
+              - Market Profile: strategies/market-profile.md
+              - Consensus: strategies/consensus.md
+          - Advanced Strategies:
+              - KBS Strategy: strategies/kbs.md
+              - Custom Strategies: strategies/custom.md
+      - Data Sources:
+          - Overview: data-sources/index.md
+
+  - Advanced:
+      - Overview: advanced/index.md
+      - Portfolio Management: advanced/portfolio.md
+      - Backtesting: advanced/backtesting.md
+      - Strategy Generator: advanced/strategy-generator.md
+      - Genetic Programming: genetic_programming.md
+      - Real-Time Streaming: advanced/streaming.md
+      - FPOP Analysis: advanced/fpop.md
+      - Risk Management: advanced/risk-management.md
+      - Portfolio Optimizer: advanced/portfolio-optimizer.md
+      - Ensemble Strategies: advanced/ensemble.md
+      - Multi-Timeframe: advanced/multi-timeframe.md
+      - Pattern Matcher: advanced/pattern-matcher.md
+      - AI & Machine Learning:
+          - Overview: ai_and_ml.md
+          - Mean Reversion: mean_reversion.md
+          - Predict Next Value: predict_next_value.md
+          - Wave Condition: identify_wave_condition.md
+          - LIBSVM Format: libsvm_file_format.md
 
   - API Reference:
-    - api/index.md
-    - SQA Module: api/sqa.md
-    - Stock Class: api/stock.md
-    - DataFrame Class: api/dataframe.md
-    - Strategy Framework: api/strategy.md
-    - Portfolio Class: api/portfolio.md
-    - Backtest Class: api/backtest.md
-    - Stream Class: api/stream.md
-
-  - Data Sources:
-    - data-sources/index.md
-    - Alpha Vantage: alpha_vantage_technical_indicators.md
-    - Data Format: data-sources/format.md
-    - Custom Data: data-sources/custom.md
+      - Overview: api/index.md
+      - DataFrame Class: api/dataframe.md
+      - Complete API Reference: api-reference/index.md
 
   - Resources:
-    - Tags: tags.md
-    - Requirements: requirements.md
-    - Terms of Use: terms_of_use.md
-    - Trading Ideas: i_gotta_an_idea.md
-    - Factor Analysis: factors_that_impact_price.md
-    - External Tools:
-      - TA-Lib: ta_lib.md
-      - FinViz: finviz.md
-      - FX Pro Bit: fx_pro_bit.md
-    - Options Trading: options.md
-
-  - Contributing:
-    - contributing/index.md
-    - Development Setup: contributing/setup.md
-    - Testing: contributing/testing.md
-    - Code Style: contributing/style.md
+      - Tags: tags.md
+      - Requirements: requirements.md
+      - Terms of Use: terms_of_use.md
+      - Trading Ideas: i_gotta_an_idea.md
+      - Factor Analysis: factors_that_impact_price.md
+      - External Tools:
+          - FinViz: finviz.md
+          - FX Pro Bit: fx_pro_bit.md
+      - Options Trading: options.md
+      - Contributing: contributing/index.md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.37
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -345,6 +345,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Simplistic playpen (e.g. not for serious use) for doing
   technical analysis of stock prices.  Under Construction.
@@ -398,7 +426,7 @@ files:
 - data/talk_talk.json
 - develop_summary.md
 - docs/.gitignore
-- docs/README.md
+- docs/IMPROVEMENT_PLAN.md
 - docs/advanced/backtesting.md
 - docs/advanced/ensemble.md
 - docs/advanced/fpop.md
@@ -411,47 +439,91 @@ files:
 - docs/advanced/strategy-generator.md
 - docs/advanced/streaming.md
 - docs/ai_and_ml.md
-- docs/alpha_vantage_technical_indicators.md
+- docs/api-reference/alphavantageapi.md
+- docs/api-reference/apierror.md
+- docs/api-reference/index.md
+- docs/api-reference/notimplemented.md
+- docs/api-reference/sqa.md
+- docs/api-reference/sqa_backtest.md
+- docs/api-reference/sqa_backtest_results.md
+- docs/api-reference/sqa_badparametererror.md
+- docs/api-reference/sqa_config.md
+- docs/api-reference/sqa_configurationerror.md
+- docs/api-reference/sqa_datafetcherror.md
+- docs/api-reference/sqa_dataframe.md
+- docs/api-reference/sqa_dataframe_alphavantage.md
+- docs/api-reference/sqa_dataframe_data.md
+- docs/api-reference/sqa_dataframe_yahoofinance.md
+- docs/api-reference/sqa_ensemble.md
+- docs/api-reference/sqa_fpop.md
+- docs/api-reference/sqa_geneticprogram.md
+- docs/api-reference/sqa_geneticprogram_individual.md
+- docs/api-reference/sqa_marketregime.md
+- docs/api-reference/sqa_multitimeframe.md
+- docs/api-reference/sqa_patternmatcher.md
+- docs/api-reference/sqa_pluginmanager.md
+- docs/api-reference/sqa_portfolio.md
+- docs/api-reference/sqa_portfolio_position.md
+- docs/api-reference/sqa_portfolio_trade.md
+- docs/api-reference/sqa_portfoliooptimizer.md
+- docs/api-reference/sqa_riskmanager.md
+- docs/api-reference/sqa_seasonalanalyzer.md
+- docs/api-reference/sqa_sectoranalyzer.md
+- docs/api-reference/sqa_stock.md
+- docs/api-reference/sqa_strategy.md
+- docs/api-reference/sqa_strategy_bollingerbands.md
+- docs/api-reference/sqa_strategy_common.md
+- docs/api-reference/sqa_strategy_consensus.md
+- docs/api-reference/sqa_strategy_ema.md
+- docs/api-reference/sqa_strategy_kbs.md
+- docs/api-reference/sqa_strategy_macd.md
+- docs/api-reference/sqa_strategy_mp.md
+- docs/api-reference/sqa_strategy_mr.md
+- docs/api-reference/sqa_strategy_random.md
+- docs/api-reference/sqa_strategy_rsi.md
+- docs/api-reference/sqa_strategy_sma.md
+- docs/api-reference/sqa_strategy_stochastic.md
+- docs/api-reference/sqa_strategy_volumebreakout.md
+- docs/api-reference/sqa_strategygenerator.md
+- docs/api-reference/sqa_strategygenerator_pattern.md
+- docs/api-reference/sqa_strategygenerator_patterncontext.md
+- docs/api-reference/sqa_strategygenerator_profitablepoint.md
+- docs/api-reference/sqa_stream.md
+- docs/api-reference/sqa_ticker.md
+- docs/api-reference/string.md
 - docs/api/dataframe.md
 - docs/api/index.md
 - docs/assets/css/custom.css
+- docs/assets/images/advanced-workflow.svg
+- docs/assets/images/architecture.svg
+- docs/assets/images/data-flow.svg
+- docs/assets/images/getting-started-workflow.svg
+- docs/assets/images/sqa.jpg
+- docs/assets/images/strategy-flow.svg
+- docs/assets/images/system-architecture.svg
 - docs/assets/js/mathjax.js
-- docs/average_true_range.md
-- docs/bollinger_bands.md
-- docs/candlestick_pattern_recognizer.md
 - docs/concepts/index.md
 - docs/contributing/index.md
 - docs/data-sources/index.md
 - docs/data_frame.md
-- docs/donchian_channel.md
-- docs/double_top_bottom_pattern.md
-- docs/exponential_moving_average.md
 - docs/factors_that_impact_price.md
-- docs/fibonacci_retracement.md
 - docs/finviz.md
 - docs/fx_pro_bit.md
 - docs/genetic_programming.md
 - docs/getting-started/index.md
 - docs/getting-started/installation.md
 - docs/getting-started/quick-start.md
-- docs/head_and_shoulders_pattern.md
 - docs/i_gotta_an_idea.md
 - docs/identify_wave_condition.md
 - docs/index.md
 - docs/indicators.md
 - docs/indicators/index.md
 - docs/libsvm_file_format.md
-- docs/market_profile.md
+- docs/llms.txt
 - docs/mean_reversion.md
-- docs/momentum.md
-- docs/moving_average_convergence_divergence.md
 - docs/options.md
-- docs/peaks_and_valleys.md
 - docs/predict_next_value.md
-- docs/relative_strength_index.md
 - docs/requirements.md
-- docs/simple_moving_average.md
-- docs/stochastic_oscillator.md
 - docs/strategies/bollinger-bands.md
 - docs/strategies/consensus.md
 - docs/strategies/custom.md
@@ -466,12 +538,8 @@ files:
 - docs/strategies/stochastic.md
 - docs/strategies/volume-breakout.md
 - docs/strategy.md
-- docs/ta_lib.md
 - docs/tags.md
 - docs/terms_of_use.md
-- docs/true_range.md
-- docs/true_strength_index.md
-- docs/weighted_moving_average.md
 - examples/README.md
 - examples/advanced_features_example.rb
 - examples/fpop_analysis_example.rb
@@ -503,20 +571,6 @@ files:
 - examples/rails_app/config/environment.rb
 - examples/rails_app/config/routes.rb
 - examples/realtime_stream_example.rb
-- examples/sinatra_app/Gemfile
-- examples/sinatra_app/QUICKSTART.md
-- examples/sinatra_app/README.md
-- examples/sinatra_app/app.rb
-- examples/sinatra_app/config.ru
-- examples/sinatra_app/public/css/style.css
-- examples/sinatra_app/public/js/app.js
-- examples/sinatra_app/views/analyze.erb
-- examples/sinatra_app/views/backtest.erb
-- examples/sinatra_app/views/dashboard.erb
-- examples/sinatra_app/views/error.erb
-- examples/sinatra_app/views/index.erb
-- examples/sinatra_app/views/layout.erb
-- examples/sinatra_app/views/portfolio.erb
 - examples/strategy_generator_example.rb
 - hsa_portfolio.csv
 - justfile

data/docs/README.md

@@ -1,43 +0,0 @@
-# README.md
-
-"Playing the market" has always felt like "playing roulette" at the casino - "you pays your money and you takes your chances".  Some players are winners.  Some are losers.  But **the House Always Wins.**
-
-Before computers, swings in the market were caused by people.  These days I believe that computers have more to do with it than public trader sentiment.  One computer program can start a cascade of other computer programs selling or buying in a digital frenzy of trading chaos.
-
-There are supposed to be tripwires in the system that protect against such things.
-
-## Recent Computer-caused Chaos
-
-I asked my AI assistant "do you know of any times when computer programs caused trading chaos in the stock market?"
-
-Yes, there have been several instances in history when computer programs have contributed to chaos in the stock market. Here are a few notable examples:
-
-1. **Flash Crash, 2010:** On May 6, 2010, U.S. financial markets experienced a brief, severe, and rapidly-reversed drop in stock prices. The Dow Jones Industrial Average plunged by over 1,000 points in a matter of minutes, only to recover just as quickly. This event is known as the "Flash Crash". The crash was primarily blamed on high-frequency trading algorithms - computer programs that execute trades at incredibly high speeds.
-
-2. **Knight Capital Group Incident, 2012:** On August 1, 2012, the company Knight Capital Group experienced a major malfunction in its automated trading software. The software executed trades worth $7 billion in about half an hour, causing Knight Capital's stock price to collapse and leading to a $440 million loss for the company.
-
-3. **Facebook's IPO, 2012:** During the initial public offering of Facebook on May 18, 2012, the stock exchange NASDAQ experienced significant technical problems. The defective technology running NASDAQ’s trading software resulted in a delay of the start of trading and confusion over individual share orders, leading to a chaotic and disorderly start to Facebook's life as a public company.
-
-4. **Swiss Franc Surge, 2015:** On January 15, 2015, the Swiss franc surged nearly 30% in a matter of minutes after the Swiss National Bank unexpectedly abolished a cap on the franc's value against the euro. Many automated trading systems were not equipped to handle this abrupt change, resulting in massive losses for many traders and companies.
-
-These events highlight the importance of careful design and rigorous testing for trading algorithms and software systems. They also demonstrate the potential for extreme market volatility in the face of unforeseen software failures or unexpected economic events.
-
-## How to be a Winner
-
-**Knowledge is King** at the casino when playing blackjack, if you can count the cards without getting caught and killed, you can gain a very small advantage over the house.  I was once given the advice to never trade a company that I did not know inside and out or in an industry in which I had no expertise.  Basically the more you know about a company the better your chances of making a beneficial trade.  I guess the extreme of that is being an insider; but there are laws against that right?  Or is it like blackjack and you should just not get caught?
-
-Is it possible to "beat the system?"  Lots of people have become wealthy selling books or services that purport to teach you how.  They all contain the same or similar disclaimers:
-
-> Decisions to buy, sell, hold or trade in securities, commodities and other investments involve risk and are best made based on the advice of qualified financial professionals. Any trading in securities or other investments involves a risk of substantial losses.
->
-> Before undertaking any trading program, you should consult a qualified financial professional. Please consider carefully whether such trading is suitable for you in light of your financial condition and ability to bear financial risks. **Under no circumstances shall we be liable** for any loss or damage you or anyone else incurs as a result of any trading or investment activity that you or anyone else engages in based on any information or material you receive through us or our services.
-
-Here's my favorite:
-
-> Hypothetical performance results have many inherent limitations. No representation is being made that any account will or is likely to achieve profits or losses similar to those shown. In fact, there are frequently sharp differences between hypothetical performance results and actual results subsequently achieved by any particular trading program.
->
-> One of the limitations of hypothetical performance results is that they are generally prepared with the benefit of hindsight. In addition, hypothetical trading does not involve financial risk and no hypothetical trading record can completely account for the impact of financial risk in actual trading. For example the ability to withstand losses or to adhere to a particular trading program in spite of the trading losses are material points, which can also adversely affect trading results. There are numerous other factors related to the market in general or to the implementation of any specific trading program which cannot be fully accounted for in the preparation of hypothetical performance results and all of which can adversely affect actual trading results.
-
-So it other words "you pays your money and you takes your chances."
-
-**The House Always Wins**

data/docs/alpha_vantage_technical_indicators.md

@@ -1,62 +0,0 @@
-# Alpha Vantage
-## Technical Indicators
-
-The following technical indicators are available from Alpha Vantage
-using a free API key.
-
-| Acronym   | Indicator Description                                    |
-|-----------|----------------------------------------------------------|
-| AD        | Accumulation/Distribution                               |
-| ADOSC     | Accumulation/Distribution Oscillator                    |
-| ADX       | Average Directional Index                               |
-| ADXR      | Average Directional Movement Rating                     |
-| APO       | Absolute Price Oscillator                              |
-| AROON     | Aroon Indicator                                        |
-| AROONOSC  | Aroon Oscillator                                       |
-| ATR       | Average True Range                                     |
-| BBANDS    | Bollinger Bands                                        |
-| BOP       | Balance of Power                                       |
-| CCI       | Commodity Channel Index                                |
-| CMO       | Chande Momentum Oscillator                             |
-| DEMA      | Double Exponential Moving Average                      |
-| DX        | Directional Movement Index                             |
-| EMA       | Exponential Moving Average                             |
-| HT_DCPERIOD | Hilbert Transform - Dominant Cycle Period             |
-| HT_DCPHASE | Hilbert Transform - Dominant Cycle Phase              |
-| HT_PHASOR  | Hilbert Transform - Phasor Components                  |
-| HT_SINE    | Hilbert Transform - SineWave                           |
-| HT_TRENDLINE | Hilbert Transform - Instantaneous Trendline           |
-| HT_TRENDMODE | Hilbert Transform - Trend vs Cycle Mode               |
-| KAMA       | Kaufman Adaptive Moving Average                        |
-| MACD       | Moving Average Convergence Divergence                  |
-| MACDEXT    | MACD with controllable MA type                         |
-| MAMA       | MESA Adaptive Moving Average                           |
-| MFI        | Money Flow Index                                      |
-| MIDPOINT   | MidPoint over period                                   |
-| MIDPRICE   | Midpoint Price over period                             |
-| MINUS_DI   | Minus Directional Indicator                            |
-| MINUS_DM   | Minus Directional Movement                             |
-| MOM        | Momentum                                              |
-| NATR       | Normalized Average True Range                          |
-| OBV        | On Balance Volume                                     |
-| PLUS_DI    | Plus Directional Indicator                             |
-| PLUS_DM    | Plus Directional Movement                              |
-| PPO        | Percentage Price Oscillator                            |
-| ROC        | Rate of Change                                        |
-| ROCR       | Rate of Change Ratio                                  |
-| RSI        | Relative Strength Index                               |
-| SAR        | Parabolic SAR                                         |
-| SMA        | Simple Moving Average                                  |
-| STOCH      | Stochastic Oscillator                                 |
-| STOCHF     | Stochastic Fast                                       |
-| STOCHRSI   | Stochastic Relative Strength Index                     |
-| T3         | Triple Exponential Moving Average (T3)                |
-| TEMA       | Triple Exponential Moving Average                      |
-| TRANGE     | True Range                                            |
-| TRIMA      | Triangular Moving Average                              |
-| TRIX       | 1-day Rate of Change of a Triple Smooth EMA            |
-| ULTOSC     | Ultimate Oscillator                                   |
-| VWAP       | Volume Weighted Average Price                          |
-| WILLR      | Williams' %R                                          |
-| WMA        | Weighted Moving Average                                |
-

data/docs/average_true_range.md

@@ -1,9 +0,0 @@
-# Average True Range (ATR)
-
-See: https://www.fidelity.com/learning-center/trading-investing/technical-analysis/technical-indicator-guide/atr
-
-The ATR is an indicator that calculates the average of the True Range values over a specified period. It provides a measure of the average volatility of a security over that period.
-
-The ATR is commonly used to assess the volatility of a security, identify potential trend reversals, and determine appropriate stop-loss levels. Higher ATR values indicate higher volatility, while lower ATR values indicate lower volatility.
-
-For example, a 14-day ATR would calculate the average of the True Range values over the past 14 trading days. Traders and analysts may use this indicator to set stop-loss levels based on the average volatility of the security.

data/docs/bollinger_bands.md

@@ -1,15 +0,0 @@
-
-
-# Bollinger Bands
-
-This method takes in an array of historical prices for a stock, a period (the number of days to calculate the moving average and standard deviation over), and the number of standard deviations to use for the upper and lower Bollinger Bands. It uses the `moving_averages` method to calculate the moving average for the given period, and then calculates the standard deviation of the closing prices for each window of the given period. Finally, it calculates the upper and lower Bollinger Bands based on the moving average and standard deviation, and returns an array containing the upper and lower bands.
-
-The `num_std_dev` parameter in the Bollinger Bands method specifies the number of standard deviations to use for the upper and lower bands. The default value for this parameter can depend on the specific security being analyzed and the time period being used.
-
-A common default value for `num_std_dev` is 2, which corresponds to the standard deviation of the price data over the given time period. Using a value of 2 for `num_std_dev` will result in the upper and lower bands being placed at a distance of two standard deviations from the moving average.
-
-However, the optimal value for `num_std_dev` can vary depending on the volatility of the security being analyzed. For highly volatile securities, a larger value for `num_std_dev` may be more appropriate, while for less volatile securities, a smaller value may be more appropriate.
-
-Ultimately, the best default value for `num_std_dev` will depend on the specific use case and should be chosen based on the characteristics of the security being analyzed and the preferences of the analyst.
-
-The difference between the upper and lower bands can be an indicator of how volatile the stock is.

data/docs/candlestick_pattern_recognizer.md

@@ -1,4 +0,0 @@
-# Candlestick Chart Pattern
-
-Recognizes common candlestick chart patterns in the given price data.
-

data/docs/donchian_channel.md

@@ -1,5 +0,0 @@
-# Donchian Channel
-
-In the domain of computer programming, a Donchian Channel is a technical analysis indicator used to identify potential breakouts and trend reversals in financial markets. It consists of three lines: the upper channel line, the lower channel line, and the middle line.
-
-The upper channel line is calculated by finding the highest high over a specified period of time, while the lower channel line is calculated by finding the lowest low over the same period. The middle line is simply the average of the upper and lower channel lines.

data/docs/double_top_bottom_pattern.md

@@ -1,3 +0,0 @@
-# Double Top Double Bottom Pattern
-
-Checks if a "double top" or "double bottom" pattern is present in the given price data.

data/docs/exponential_moving_average.md

@@ -1,19 +0,0 @@
-# Exponential Moving Average (EMA)
-
-In financial analysis, the Exponential Moving Average (EMA) is a commonly used technical indicator that helps identify trends and smooth out price data. It is a type of moving average that gives more weight to recent prices, making it more responsive to recent price changes compared to other moving averages.
-
-The EMA is calculated by applying a smoothing factor (often represented as a percentage) to the previous EMA value and adding a weighted average of the current price. The smoothing factor determines the weight given to the most recent price data, with higher values giving more weight to recent prices.
-
-The EMA is used for various purposes in financial analysis, including:
-
-1. Trend Identification: The EMA is often used to identify the direction and strength of a trend. When the current price is above the EMA, it suggests an uptrend, while a price below the EMA suggests a downtrend. Traders and investors may use the EMA crossover (when the price crosses above or below the EMA) as a signal to enter or exit positions.
-
-2. Support and Resistance Levels: The EMA can act as dynamic support or resistance levels. In an uptrend, the EMA may provide support, and in a downtrend, it may act as resistance. Traders may use the EMA as a reference point for setting stop-loss orders or profit targets.
-
-3. Price Reversals: The EMA can help identify potential price reversals. When the price deviates significantly from the EMA, it may indicate an overbought or oversold condition, suggesting a potential reversal in the near future. Traders may use this information to anticipate price reversals and adjust their trading strategies accordingly.
-
-4. Volatility Assessment: The EMA can be used to assess market volatility. When the EMA is relatively flat, it suggests low volatility, while a steeply sloping EMA indicates higher volatility. Traders may adjust their trading strategies based on the level of volatility indicated by the EMA.
-
-It's important to note that the EMA is just one of many technical indicators used in financial analysis. It is often used in combination with other indicators, such as the Simple Moving Average (SMA), to gain a more comprehensive understanding of market trends and price movements.
-
-Traders and investors should consider their own trading strategies, risk tolerance, and timeframes when using the EMA or any other technical indicator for financial analysis. It's also recommended to backtest and validate any trading strategies before applying them in real-time trading.