Update documentation to reflect the addition of indicators and patterns in Pandas TA Classic
This commit is contained in:
@@ -20,7 +20,7 @@
|
||||
|
||||

|
||||
|
||||
**Pandas TA Classic** is an easy-to-use library that leverages the Pandas package with **130+ indicators** and utility functions and **60+ TA Lib candlestick patterns**. Many commonly used indicators are included, such as: _Simple Moving Average_ (**sma**), _Moving Average Convergence Divergence_ (**macd**), _Hull Exponential Moving Average_ (**hma**), _Bollinger Bands_ (**bbands**), _On-Balance Volume_ (**obv**), _Aroon & Aroon Oscillator_ (**aroon**), _Squeeze_ (**squeeze**) and **many more**.
|
||||
**Pandas TA Classic** is an easy-to-use library that leverages the Pandas package with **143 indicators and utility functions** and **62 TA Lib candlestick patterns** (**205 total**). Many commonly used indicators are included, such as: _Simple Moving Average_ (**sma**), _Moving Average Convergence Divergence_ (**macd**), _Hull Exponential Moving Average_ (**hma**), _Bollinger Bands_ (**bbands**), _On-Balance Volume_ (**obv**), _Aroon & Aroon Oscillator_ (**aroon**), _Squeeze_ (**squeeze**) and **many more**.
|
||||
|
||||
This is the **classic/community maintained version** of the popular pandas-ta library.
|
||||
|
||||
@@ -61,7 +61,9 @@ df.ta.strategy("CommonStrategy") # Runs commonly used indicators
|
||||
|
||||
## 📊 Features
|
||||
|
||||
- **130+ Technical Indicators** across 9 categories (Candles, Momentum, Overlap, Trend, Volume, etc.)
|
||||
- **143 Technical Indicators & Utilities** across 9 categories (Candles, Momentum, Overlap, Trend, Volume, etc.)
|
||||
- **62 TA Lib Candlestick Patterns** for comprehensive pattern recognition
|
||||
- **205 Total Indicators & Patterns** - the most comprehensive Python TA library
|
||||
- **Strategy System** with multiprocessing support for bulk indicator processing
|
||||
- **Pandas DataFrame Extension** for seamless integration (`df.ta.indicator()`)
|
||||
- **TA Lib Integration** - automatically uses TA Lib versions when available
|
||||
@@ -75,7 +77,7 @@ df.ta.strategy("CommonStrategy") # Runs commonly used indicators
|
||||
### Quick Links
|
||||
- 📖 [**Usage Guide**](https://xgboosted.github.io/pandas-ta-classic/usage.html) - Programming conventions and basic usage
|
||||
- 🏗️ [**Strategy System**](https://xgboosted.github.io/pandas-ta-classic/strategies.html) - Multiprocessing and bulk indicator processing
|
||||
- 📊 [**Indicators Reference**](https://xgboosted.github.io/pandas-ta-classic/indicators.html) - Complete list of all 130+ indicators
|
||||
- 📊 [**Indicators Reference**](https://xgboosted.github.io/pandas-ta-classic/indicators.html) - Complete list of all 143 indicators & 62 patterns
|
||||
- 🔧 [**DataFrame API**](https://xgboosted.github.io/pandas-ta-classic/dataframe_api.html) - Properties and methods reference
|
||||
- 📈 [**Performance Metrics**](https://xgboosted.github.io/pandas-ta-classic/performance.html) - Backtesting and performance analysis
|
||||
- 💡 [**Examples**](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples) - Jupyter notebooks and code examples
|
||||
|
||||
+9
-9
@@ -1,23 +1,23 @@
|
||||
Indicators Reference
|
||||
===================
|
||||
|
||||
**Pandas TA Classic** includes 130+ indicators and utility functions organized into the following categories:
|
||||
**Pandas TA Classic** includes 143 indicators and utility functions plus 62 TA-Lib candlestick patterns (205 total) organized into the following categories:
|
||||
|
||||
* **Candles** (64) - Candlestick patterns for market sentiment analysis
|
||||
* **Candles** (65) - Candlestick patterns for market sentiment analysis (3 native + 62 TA-Lib patterns)
|
||||
* **Cycles** (1) - Cycle-based technical indicators
|
||||
* **Momentum** (41) - Momentum and oscillator indicators
|
||||
* **Overlap** (33) - Moving averages and trend-following indicators
|
||||
* **Overlap** (34) - Moving averages and trend-following indicators
|
||||
* **Performance** (3) - Performance and return metrics
|
||||
* **Statistics** (11) - Statistical analysis functions
|
||||
* **Statistics** (10) - Statistical analysis functions
|
||||
* **Trend** (18) - Trend identification and direction indicators
|
||||
* **Utility** (5) - Helper and utility functions
|
||||
* **Utility** (10) - Helper and utility functions
|
||||
* **Volatility** (14) - Volatility and range-based indicators
|
||||
* **Volume** (15) - Volume analysis indicators
|
||||
|
||||
Candles (64)
|
||||
Candles (65)
|
||||
------------
|
||||
|
||||
Candlestick patterns for identifying market sentiment and potential reversals. Patterns that are **not bold** require TA-Lib to be installed: ``pip install TA-Lib``
|
||||
Candlestick patterns for identifying market sentiment and potential reversals. This includes 3 native patterns (**cdl_pattern**, **cdl_z**, **ha**) plus 62 TA-Lib patterns. Patterns that are **not bold** require TA-Lib to be installed: ``pip install TA-Lib``
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@@ -96,7 +96,7 @@ Momentum and oscillator indicators for measuring the speed of price changes:
|
||||
* *Ultimate Oscillator*: **uo**
|
||||
* *Williams %R*: **willr**
|
||||
|
||||
Overlap (33)
|
||||
Overlap (34)
|
||||
------------
|
||||
|
||||
Moving averages and trend-following indicators:
|
||||
@@ -144,7 +144,7 @@ Performance and return metrics. Use parameter ``cumulative=True`` for cumulative
|
||||
* *Log Return*: **log_return**
|
||||
* *Percent Return*: **percent_return**
|
||||
|
||||
Statistics (11)
|
||||
Statistics (10)
|
||||
---------------
|
||||
|
||||
Statistical analysis functions:
|
||||
|
||||
@@ -52,16 +52,16 @@ For detailed documentation, examples, and the complete list of indicators, pleas
|
||||
|
||||
## Categories of Indicators
|
||||
|
||||
- **Candles** (64): Pattern recognition indicators
|
||||
- **Candles** (65): Pattern recognition indicators (3 native + 62 TA-Lib patterns)
|
||||
- **Momentum** (41): RSI, MACD, Stochastic, etc.
|
||||
- **Overlap** (33): Moving averages, Bollinger Bands, etc.
|
||||
- **Overlap** (34): Moving averages, Bollinger Bands, etc.
|
||||
- **Trend** (18): ADX, Aroon, Parabolic SAR, etc.
|
||||
- **Volume** (15): OBV, Money Flow, etc.
|
||||
- **Volatility** (14): ATR, Bollinger Bands, etc.
|
||||
- **Statistics** (11): Z-Score, Standard Deviation, etc.
|
||||
- **Statistics** (10): Z-Score, Standard Deviation, etc.
|
||||
- **Performance** (3): Returns, Drawdown analysis
|
||||
- **Cycles** (1): Even Better Sinewave
|
||||
- **Utility** (5): Helper functions
|
||||
- **Utility** (10): Helper functions
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
Reference in New Issue
Block a user