diff --git a/README.md b/README.md index 0ec39467..105c3a95 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![PyPI](https://img.shields.io/pypi/v/stock-indicators?color=blue&label=PyPI)](https://badge.fury.io/py/stock-indicators) [![code coverage](https://img.shields.io/azure-devops/coverage/skender/stock.indicators/26/main?logo=AzureDevOps&label=Test%20Coverage)](https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=26&branchName=main&view=codecoverage-tab) +![PyPI - Downloads](https://img.shields.io/pypi/dm/stock-indicators?style=flat&logo=Python&logoColor=white&label=Downloads&color=indigo&link=https%3A%2F%2Fpypistats.org%2Fpackages%2Fstock-indicators) # Stock Indicators for Python diff --git a/docs/GemFile.lock b/docs/GemFile.lock index 7a3a5f05..49263b79 100644 --- a/docs/GemFile.lock +++ b/docs/GemFile.lock @@ -8,7 +8,7 @@ GIT GEM remote: https://rubygems.org/ specs: - activesupport (7.1.2) + activesupport (7.1.3) base64 bigdecimal concurrent-ruby (~> 1.0, >= 1.0.2) @@ -21,14 +21,14 @@ GEM addressable (2.8.6) public_suffix (>= 2.0.2, < 6.0) base64 (0.2.0) - bigdecimal (3.1.5) + bigdecimal (3.1.6) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.11.1) colorator (1.1.0) commonmarker (0.23.10) - concurrent-ruby (1.2.2) + concurrent-ruby (1.2.3) connection_pool (2.4.1) cssminify2 (2.0.1) dnsruby (1.70.0) @@ -242,7 +242,7 @@ GEM jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.21.1) + minitest (5.21.2) mutex_m (0.2.0) net-http (0.4.1) uri diff --git a/docs/_data/aliases.yml b/docs/_data/aliases.yml index ff48d6d4..da45c202 100644 --- a/docs/_data/aliases.yml +++ b/docs/_data/aliases.yml @@ -2,6 +2,14 @@ permalink: /indicators/ElderRay/ type: price-characteristic +- title: Dominant Cycle Periods + permalink: /indicators/HtTrendline/ + type: price-characteristic + +- title: Directional Movement Index (DMI) + permalink: /indicators/Adx/ + type: price-trend + - title: Historical Volatility (HV) permalink: /indicators/StdDev/ type: price-characteristic @@ -58,10 +66,6 @@ permalink: /indicators/Hurst/ type: price-characteristic -- title: ROC with Bands - permalink: /indicators/Roc/ - type: oscillator - - title: Running Moving Average (RMA) permalink: /indicators/Smma/ type: moving-average @@ -70,6 +74,10 @@ permalink: /indicators/SuperTrend/ type: stop-and-reverse +- title: True Range (TR) + permalink: /indicators/Atr/ + type: price-characteristic + - title: Z-Score permalink: /indicators/StdDev/ type: numerical-analysis diff --git a/docs/_indicators/Adl.md b/docs/_indicators/Adl.md index 1ba565e3..a3ee90d1 100644 --- a/docs/_indicators/Adl.md +++ b/docs/_indicators/Adl.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `sma_periods` | int, Optional | Number of periods (`N`) in the moving average of ADL. Must be greater than 0, if specified. ### Historical quotes requirements diff --git a/docs/_indicators/Adx.md b/docs/_indicators/Adx.md index c8f9c82d..eb75e0ea 100644 --- a/docs/_indicators/Adx.md +++ b/docs/_indicators/Adx.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) for the lookback evaluation. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Alligator.md b/docs/_indicators/Alligator.md index 596c4c7c..f6bedfa9 100644 --- a/docs/_indicators/Alligator.md +++ b/docs/_indicators/Alligator.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- | -- | -- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `jaw_periods` | int, *default 13* | Number of periods (`JP`) for the Jaw moving average. Must be greater than `teeth_periods`. | `jaw_offset` | int, *default 8* | Number of periods (`JO`) for the Jaw offset. Must be greater than 0. | `teeth_periods` | int, *default 8* | Number of periods (`TP`) for the Teeth moving average. Must be greater than `lips_periods`. diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md index 18c5c81e..81b7f032 100644 --- a/docs/_indicators/Alma.md +++ b/docs/_indicators/Alma.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 9* | Number of periods (`N`) in the moving average. Must be greater than 1, but is typically in the 5-20 range. | `offset` | float, *default 0.85* | Adjusts smoothness versus responsiveness on a scale from 0 to 1; where 1 is max responsiveness. | `sigma` | float, *default 6* | Defines the width of the Gaussian [normal distribution](https://en.wikipedia.org/wiki/Normal_distribution). Must be greater than 0. diff --git a/docs/_indicators/Aroon.md b/docs/_indicators/Aroon.md index 721a0789..0998a76e 100644 --- a/docs/_indicators/Aroon.md +++ b/docs/_indicators/Aroon.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- | -- | -- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 25* | Number of periods (`N`) for the lookback evaluation. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md index c6e75431..d75608c1 100644 --- a/docs/_indicators/Atr.md +++ b/docs/_indicators/Atr.md @@ -9,11 +9,16 @@ layout: indicator >**get_atr**(*quotes, lookback_periods=14*) +### Related interfaces + +For raw True Range (TR) only, use: +>**get_tr**(quotes) -> TrResults[TrResult] + ## Parameters | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) to consider. Must be greater than 1. ### Historical quotes requirements diff --git a/docs/_indicators/Awesome.md b/docs/_indicators/Awesome.md index 00145994..7fe7fade 100644 --- a/docs/_indicators/Awesome.md +++ b/docs/_indicators/Awesome.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_periods` | int, *default 5* | Number of periods (`F`) for the faster moving average. Must be greater than 0. | `slow_periods` | int, *default 34* | Number of periods (`S`) for the slower moving average. Must be greater than `fast_periods`. diff --git a/docs/_indicators/Beta.md b/docs/_indicators/Beta.md index 7dcf6680..995782e1 100644 --- a/docs/_indicators/Beta.md +++ b/docs/_indicators/Beta.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `eval_history` | Iterable[Quote] | Historical [evaluation stock] Quotes data should be at any consistent frequency (day, hour, minute, etc).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `eval_history` | Iterable[Quote] | Historical [evaluation stock] Quotes data should be at any consistent frequency (day, hour, minute, etc).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `market_history` | Iterable[Quote] | Historical [market] Quotes data should be at any consistent frequency (day, hour, minute, etc). This `market` quotes will be used to establish the baseline. | `lookback_periods` | int | Number of periods (`N`) in the lookback period. Must be greater than 0 to calculate; however we suggest a larger period for statistically appropriate sample size and especially when using Beta +/-. | `beta_type` | BetaType, *default BetaType.STANDARD* | Type of Beta to calculate. See [BetaType options](#betatype-options) below. diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md index 0267b3d1..fd197ba6 100644 --- a/docs/_indicators/BollingerBands.md +++ b/docs/_indicators/BollingerBands.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 20* | Number of periods (`N`) for the center line moving average. Must be greater than 1 to calculate; however we suggest a larger period for statistically appropriate sample size. | `standard_deviations` | int, *default 2* | Width of bands. Standard deviations (`D`) from the moving average. Must be greater than 0. diff --git a/docs/_indicators/Bop.md b/docs/_indicators/Bop.md index d3b15565..98dd5db2 100644 --- a/docs/_indicators/Bop.md +++ b/docs/_indicators/Bop.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `smooth_periods` | int, *default 14* | Number of periods (`N`) for smoothing. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Cci.md b/docs/_indicators/Cci.md index fb169ceb..4460e0c5 100644 --- a/docs/_indicators/Cci.md +++ b/docs/_indicators/Cci.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 20* | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/ChaikinOsc.md b/docs/_indicators/ChaikinOsc.md index 63c8f5f5..14d837cd 100644 --- a/docs/_indicators/ChaikinOsc.md +++ b/docs/_indicators/ChaikinOsc.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_periods` | int, *default 3* | Number of periods (`F`) in the ADL fast EMA. Must be greater than 0 and smaller than `S`. | `slow_periods` | int, *default 10* | Number of periods (`S`) in the ADL slow EMA. Must be greater `F`. diff --git a/docs/_indicators/Chandelier.md b/docs/_indicators/Chandelier.md index f69d1b2c..028c7ef0 100644 --- a/docs/_indicators/Chandelier.md +++ b/docs/_indicators/Chandelier.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 22* | Number of periods (`N`) for the lookback evaluation. | `multiplier` | float, *default 3.0* | Multiplier number must be a positive value. | `chandelier_type` | ChandelierType, *default ChandelierType.LONG* | Direction of exit. See [ChandelierType options](#chandeliertype-options) below. diff --git a/docs/_indicators/Chop.md b/docs/_indicators/Chop.md index 2e8adc32..7afde226 100644 --- a/docs/_indicators/Chop.md +++ b/docs/_indicators/Chop.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) for the lookback evaluation. Must be greater than 1. ### Historical quotes requirements diff --git a/docs/_indicators/Cmf.md b/docs/_indicators/Cmf.md index 59a2f96c..0aae3a11 100644 --- a/docs/_indicators/Cmf.md +++ b/docs/_indicators/Cmf.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 20* | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md index d4208802..f8e15fbb 100644 --- a/docs/_indicators/ConnorsRsi.md +++ b/docs/_indicators/ConnorsRsi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `rsi_periods` | int, *default 3* | Lookback period (`R`) for the close price RSI. Must be greater than 1. | `streak_periods` | int, *default 2* | Lookback period (`S`) for the streak RSI. Must be greater than 1. | `rank_periods` | int, *default 100* | Lookback period (`P`) for the Percentile Rank. Must be greater than 1. diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md index bec62f77..c54a4052 100644 --- a/docs/_indicators/Correlation.md +++ b/docs/_indicators/Correlation.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes_a` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes_a` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `quotes_b` | Iterable[Quote] | Historical quotes (B) must have at least the same matching date elements of `quotes_a`. | `lookback_periods` | int | Number of periods (`N`) in the lookback period. Must be greater than 0 to calculate; however we suggest a larger period for statistically appropriate sample size. diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md index 39e47f81..2e4f48da 100644 --- a/docs/_indicators/Dema.md +++ b/docs/_indicators/Dema.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Doji.md b/docs/_indicators/Doji.md index f58c00b3..0dd6979c 100644 --- a/docs/_indicators/Doji.md +++ b/docs/_indicators/Doji.md @@ -13,7 +13,7 @@ type: candlestick-pattern | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `max_price_change_percent` | float, *default 0.1* | Optional. Maximum absolute percent difference in open and close price. Example: 0.3% would be entered as 0.3 (not 0.003). Must be between 0 and 0.5 percent, if specified. ### Historical quotes requirements diff --git a/docs/_indicators/Donchian.md b/docs/_indicators/Donchian.md index 5a750d88..5b06531b 100644 --- a/docs/_indicators/Donchian.md +++ b/docs/_indicators/Donchian.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 20* | Number of periods (`N`) for lookback period. Must be greater than 0 to calculate; however we suggest a larger value for an appropriate sample size. ### Historical quotes requirements diff --git a/docs/_indicators/Dpo.md b/docs/_indicators/Dpo.md index 2e4def2f..e80550ef 100644 --- a/docs/_indicators/Dpo.md +++ b/docs/_indicators/Dpo.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md index e1da31d0..fe74d3e1 100644 --- a/docs/_indicators/ElderRay.md +++ b/docs/_indicators/ElderRay.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 13* | Number of periods (`N`) for the underlying EMA evaluation. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Ema.md b/docs/_indicators/Ema.md index 6bda78ff..9542d3bb 100644 --- a/docs/_indicators/Ema.md +++ b/docs/_indicators/Ema.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. | `candle_part` | CandlePart, *default CandlePart.CLOSE* | Specify candle part to evaluate. See [CandlePart options](#candlepart-options) below. diff --git a/docs/_indicators/Epma.md b/docs/_indicators/Epma.md index 44581188..c75024a5 100644 --- a/docs/_indicators/Epma.md +++ b/docs/_indicators/Epma.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Fcb.md b/docs/_indicators/Fcb.md index 8eb3f914..b8abf4c8 100644 --- a/docs/_indicators/Fcb.md +++ b/docs/_indicators/Fcb.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `window_span` | int | Fractal evaluation window span width (`S`). Must be at least 2. Default is 2. The total evaluation window size is `2×S+1`, representing `±S` from the evaluation date. See [Williams Fractal](../Fractal#content) for more information about Fractals and `window_span`. diff --git a/docs/_indicators/FisherTransform.md b/docs/_indicators/FisherTransform.md index f02b4e56..c124d916 100644 --- a/docs/_indicators/FisherTransform.md +++ b/docs/_indicators/FisherTransform.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 10* | Number of periods (`N`) in the lookback window. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/ForceIndex.md b/docs/_indicators/ForceIndex.md index 93e72390..21accb0c 100644 --- a/docs/_indicators/ForceIndex.md +++ b/docs/_indicators/ForceIndex.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Lookback window (`N`) for the EMA of Force Index. Must be greater than 0 and is commonly 2 or 13 (shorter/longer view). ### Historical quotes requirements diff --git a/docs/_indicators/Fractal.md b/docs/_indicators/Fractal.md index 7ed5dcb7..90eb0cfa 100644 --- a/docs/_indicators/Fractal.md +++ b/docs/_indicators/Fractal.md @@ -17,7 +17,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `window_span` | int, *default 2* | Evaluation window span width (`S`). Must be at least 2. | `end_type` | EndType | Determines whether `close` or `high/low` are used to find end points. See [EndType options](#endtype-options) below. Default is `EndType.HIGH_LOW`. diff --git a/docs/_indicators/Gator.md b/docs/_indicators/Gator.md index 2cdee2d6..dd96a37b 100644 --- a/docs/_indicators/Gator.md +++ b/docs/_indicators/Gator.md @@ -15,7 +15,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] or Iterable[AlligatorResult] | Iterable(such as list or an object having `__iter__()`) of the [Quote]({{site.baseurl}}/guide/#historical-quotes) or [Alligator Result](../Alligator#content). +| `quotes` | Iterable[Quote] or Iterable[AlligatorResult] | Iterable of the [Quote]({{site.baseurl}}/guide/#historical-quotes) or [Alligator Result](../Alligator#content).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame ## Historical quotes requirements diff --git a/docs/_indicators/HeikinAshi.md b/docs/_indicators/HeikinAshi.md index 74e99994..e66b2c29 100644 --- a/docs/_indicators/HeikinAshi.md +++ b/docs/_indicators/HeikinAshi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame ### Historical quotes requirements diff --git a/docs/_indicators/Hma.md b/docs/_indicators/Hma.md index 2a7f198a..f306b318 100644 --- a/docs/_indicators/Hma.md +++ b/docs/_indicators/Hma.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 1. ### Historical quotes requirements diff --git a/docs/_indicators/HtTrendline.md b/docs/_indicators/HtTrendline.md index 9906ee90..789f6c92 100644 --- a/docs/_indicators/HtTrendline.md +++ b/docs/_indicators/HtTrendline.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame ## Historical quotes requirements @@ -32,6 +32,7 @@ HTTrendlineResults[HTTrendlineResult] - It always returns the same number of elements as there are in the historical quotes. - It does not return a single incremental indicator value. - The first `6` periods will have `None` values for `smooth_price` since there's not enough data to calculate. +- The first `7` periods will have `None` values for `dc_periods` since there is not enough data to calculate; and are generally unreliable for the first ~25 periods. >⚞ **Convergence warning**: The first `100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods. @@ -41,6 +42,7 @@ HTTrendlineResults[HTTrendlineResult] | -- |-- |-- | `date` | datetime | Date | `trendline` | float, Optional | HT Trendline +| `dc_periods` | int, Optional | Dominant cycle periods (smoothed) | `smooth_price` | float, Optional | Weighted moving average of `(H+L)/2` price ### Utilities diff --git a/docs/_indicators/Hurst.md b/docs/_indicators/Hurst.md index 8175090f..51d092be 100644 --- a/docs/_indicators/Hurst.md +++ b/docs/_indicators/Hurst.md @@ -14,8 +14,8 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) -| `lookback_periods` | int, *default 100* | Number of periods (`N`) in the Hurst Analysis. Must be greater than 100. +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame +| `lookback_periods` | int, *default 100* | Number of periods (`N`) in the Hurst Analysis. Must be greater than 20. ### Historical quotes requirements @@ -65,7 +65,7 @@ results = indicators.get_hurst(quotes, 20) ## About {{ page.title }} -The [Hurst Exponent](https://en.wikipedia.org/wiki/Hurst_exponent) is a [random-walk](https://en.wikipedia.org/wiki/Random_walk) path analysis that measures trending and mean-reverting tendencies of incremental return values. When `H` is greater than 0.5 it depicts trending. When `H` is less than 0.5 it is is more likely to revert to the mean. When `H` is around 0.5 it represents a random walk. +The [Hurst Exponent](https://en.wikipedia.org/wiki/Hurst_exponent) (`H`) is part of a Rescaled Range Analysis, a [random-walk](https://en.wikipedia.org/wiki/Random_walk) path analysis that measures trending and mean-reverting tendencies of incremental return values. When `H` is greater than 0.5 it depicts trending. When `H` is less than 0.5 it is is more likely to revert to the mean. When `H` is around 0.5 it represents a random walk. [[Discuss] 💬]({{site.dotnet.repo}}/discussions/477 "Community discussion about this indicator") ![image]({{site.dotnet.charts}}/Hurst.png) diff --git a/docs/_indicators/Ichimoku.md b/docs/_indicators/Ichimoku.md index b677c14a..d3920fcf 100644 --- a/docs/_indicators/Ichimoku.md +++ b/docs/_indicators/Ichimoku.md @@ -21,7 +21,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `tenkan_periods` | int, *default 9* | Number of periods (`T`) in the Tenkan-sen midpoint evaluation. Must be greater than 0. | `kijun_periods` | int, *default 26* | Number of periods (`K`) in the shorter Kijun-sen midpoint evaluation. Must be greater than 0. | `senkou_b_periods` | int, *default 52* | Number of periods (`S`) in the longer Senkou leading span B midpoint evaluation. Must be greater than `K`. diff --git a/docs/_indicators/Kama.md b/docs/_indicators/Kama.md index c2744807..37c2cc03 100644 --- a/docs/_indicators/Kama.md +++ b/docs/_indicators/Kama.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `er_periods` | int, *default 10* | Number of Efficiency Ratio (volatility) periods (`E`). Must be greater than 0. | `fast_periods` | int, *default 2* | Number of Fast EMA periods. Must be greater than 0. | `slow_periods` | int, *default 30* | Number of Slow EMA periods. Must be greater than `fast_periods`. diff --git a/docs/_indicators/Keltner.md b/docs/_indicators/Keltner.md index 0dc1e891..eccb1a69 100644 --- a/docs/_indicators/Keltner.md +++ b/docs/_indicators/Keltner.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `ema_periods` | int, *default 20* | Number of lookback periods (`E`) for the center line moving average. Must be greater than 1 to calculate. | `multiplier` | float, *default 2.0* | ATR Multiplier. Must be greater than 0. | `atr_periods` | int, *default 10* | Number of lookback periods (`A`) for the Average True Range. Must be greater than 1 to calculate. diff --git a/docs/_indicators/Kvo.md b/docs/_indicators/Kvo.md index 2f3e33e9..71886e31 100644 --- a/docs/_indicators/Kvo.md +++ b/docs/_indicators/Kvo.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_periods` | int, *default 34* | Number of lookback periods (`F`) for the short-term EMA. Must be greater than 2. | `slow_periods` | int, *default 55* | Number of lookback periods (`L`) for the long-term EMA. Must be greater than `F`. | `signal_periods` | int, *default 13* | Number of lookback periods for the signal line. Must be greater than 0. diff --git a/docs/_indicators/MaEnvelopes.md b/docs/_indicators/MaEnvelopes.md index 76d25953..e3bfd301 100644 --- a/docs/_indicators/MaEnvelopes.md +++ b/docs/_indicators/MaEnvelopes.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 1. | `percent_offset` | float, *default 2.5* | Percent offset for envelope width. Example: 3.5% would be entered as 3.5 (not 0.035). Must be greater than 0. Typical values range from 2 to 10. | `ma_type` | MAType, *default MAType.SMA* | Type of moving average (e.g. SMA, EMA, HMA). See [MAType options](#matype-options) below. diff --git a/docs/_indicators/Macd.md b/docs/_indicators/Macd.md index ee90121d..be67ce75 100644 --- a/docs/_indicators/Macd.md +++ b/docs/_indicators/Macd.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_periods` | int, *default 12* | Number of periods (`F`) for the faster moving average. Must be greater than 0. | `slow_periods` | int, *default 26* | Number of periods (`S`) for the slower moving average. Must be greater than `fast_periods`. | `signal_periods` | int, *default 9* | Number of periods (`P`) for the moving average of MACD. Must be greater than or equal to 0. diff --git a/docs/_indicators/Mama.md b/docs/_indicators/Mama.md index a5e8f599..e1dac7d1 100644 --- a/docs/_indicators/Mama.md +++ b/docs/_indicators/Mama.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_limit` | float, *default 0.5* | Fast limit threshold. Must be greater than `slowLimit` and less than 1. | `slow_limit` | float, *default 0.05* | Slow limit threshold. Must be greater than 0. diff --git a/docs/_indicators/Marubozu.md b/docs/_indicators/Marubozu.md index 754bf307..b99e3e72 100644 --- a/docs/_indicators/Marubozu.md +++ b/docs/_indicators/Marubozu.md @@ -13,7 +13,7 @@ type: candlestick-pattern | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `min_body_percent` | float, *default 95* | Optional. Minimum body size as a percent of total candle size. Example: 85% would be entered as 85 (not 0.85). Must be between 80 and 100, if specified. ### Historical quotes requirements diff --git a/docs/_indicators/Mfi.md b/docs/_indicators/Mfi.md index 86fccca6..de441760 100644 --- a/docs/_indicators/Mfi.md +++ b/docs/_indicators/Mfi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) in the lookback period. Must be greater than 1. ### Historical quotes requirements diff --git a/docs/_indicators/Obv.md b/docs/_indicators/Obv.md index 56d9d64f..8f6d8d5b 100644 --- a/docs/_indicators/Obv.md +++ b/docs/_indicators/Obv.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `sma_periods` | int, Optional | Number of periods (`N`) in the moving average of OBV. Must be greater than 0, if specified. ### Historical quotes requirements diff --git a/docs/_indicators/ParabolicSar.md b/docs/_indicators/ParabolicSar.md index af3a4923..e0d65e9e 100644 --- a/docs/_indicators/ParabolicSar.md +++ b/docs/_indicators/ParabolicSar.md @@ -17,10 +17,10 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `acceleration_step` | float, *default 0.02* | Incremental step size for the Acceleration Factor. Must be greater than 0. | `max_acceleration_factor` | float, *default 0.2* | Maximum factor limit. Must be greater than `acceleration_step`. -| `initial_factor` | float | Initial Acceleration Factor. Must be greater than 0. Default is `acceleration_step`. +| `initial_factor` | float | Initial Acceleration Factor. Must be greater than 0 and not larger than `max_acceleration_factor`. Default is `acceleration_step`. ### Historical quotes requirements diff --git a/docs/_indicators/PivotPoints.md b/docs/_indicators/PivotPoints.md index 318be454..d6bee652 100644 --- a/docs/_indicators/PivotPoints.md +++ b/docs/_indicators/PivotPoints.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `window_size` | PeriodSize | Size of the lookback window. See [PeriodSize options](#periodsize-options-for-window_size) below. | `point_type` | PivotPointType, *default PivotPointType.STANDARD* | Type of Pivot Point. See [PivotPointType options](#pivotpointtype-options) below. diff --git a/docs/_indicators/Pivots.md b/docs/_indicators/Pivots.md index 7167c499..142a1bb3 100644 --- a/docs/_indicators/Pivots.md +++ b/docs/_indicators/Pivots.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `left_span` | int, *default 2* | Left evaluation window span width (`L`). Must be at least 2. | `right_span` | int, *default 2* | Right evaluation window span width (`R`). Must be at least 2. | `max_trend_periods` | int, *default 20* | Number of periods (`N`) in evaluation window. Must be greater than `leftSpan`. diff --git a/docs/_indicators/Pmo.md b/docs/_indicators/Pmo.md index 616a66bf..2cfbecd6 100644 --- a/docs/_indicators/Pmo.md +++ b/docs/_indicators/Pmo.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `time_periods` | int, *default 35* | Number of periods (`T`) for ROC EMA smoothing. Must be greater than 1. ### Historical quotes requirements diff --git a/docs/_indicators/Prs.md b/docs/_indicators/Prs.md index 5200e821..a7a61a3c 100644 --- a/docs/_indicators/Prs.md +++ b/docs/_indicators/Prs.md @@ -13,8 +13,8 @@ layout: indicator | name | type | notes | -- |-- |-- -| `eval_history` | Iterable[Quote] | Historical quotes for evaluation. You must have the same number of periods as `base_history`.
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) -| `base_history` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). +| `eval_history` | Iterable[Quote] | Historical quotes for evaluation. You must have the same number of periods as `base_history`.
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame +| `base_history` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). | `lookback_periods` | int, Optional | Number of periods (`N`) to lookback to compute % difference. Must be greater than 0 if specified or `None`. | `sma_periods` | int, Optional | Number of periods (`S`) in the SMA lookback period for `prs`. Must be greater than 0. diff --git a/docs/_indicators/Pvo.md b/docs/_indicators/Pvo.md index 25508944..bbd1a33f 100644 --- a/docs/_indicators/Pvo.md +++ b/docs/_indicators/Pvo.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `fast_periods` | int, *default 12* | Number of periods (`F`) for the faster moving average. Must be greater than 0. | `slow_periods` | int, *default 26* | Number of periods (`S`) for the slower moving average. Must be greater than `fast_periods`. | `signal_periods` | int, *default 9* | Number of periods (`P`) for the moving average of PVO. Must be greater than or equal to 0. diff --git a/docs/_indicators/Renko.md b/docs/_indicators/Renko.md index 77355d1f..e9334ff8 100644 --- a/docs/_indicators/Renko.md +++ b/docs/_indicators/Renko.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `brick_size` | float | Brick size. Must be greater than 0. | `end_type` | EndType, *default EndType.CLOSE* | See [EndType options](#endtype-options) below. diff --git a/docs/_indicators/Roc.md b/docs/_indicators/Roc.md index 4306cb20..99246f83 100644 --- a/docs/_indicators/Roc.md +++ b/docs/_indicators/Roc.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) to go back. Must be greater than 0. | `sma_periods` | int, Optional | Number of periods in the moving average of ROC. Must be greater than 0, if specified. @@ -72,7 +72,7 @@ results = indicators.get_roc(quotes, 20) | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) to go back. Must be greater than 0. Typical values range from 10-20. | `ema_periods` | int | Number of periods for the ROC EMA line. Must be greater than 0. Standard is 3. | `std_dev_periods` | int | Number of periods the standard deviation for upper/lower band lines. Must be greater than 0 and not more than `lookback_periods`. Standard is to use same value as `lookback_periods`. diff --git a/docs/_indicators/RollingPivots.md b/docs/_indicators/RollingPivots.md index 41b57523..6fcfd759 100644 --- a/docs/_indicators/RollingPivots.md +++ b/docs/_indicators/RollingPivots.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `window_periods` | int | Number of periods (`W`) in the evaluation window. Must be greater than 0 to calculate; but is typically specified in the 5-20 range. | `offset_periods` | int | Number of periods (`F`) to offset the window from the current period. Must be greater than or equal to 0 and is typically less than or equal to `W`. | `point_type` | PivotPointType, *default PivotPointType.STANDARD* | Type of Pivot Point. See [PivotPointType options](#pivotpointtype-options) below. diff --git a/docs/_indicators/Rsi.md b/docs/_indicators/Rsi.md index 261888ec..c8165ff9 100644 --- a/docs/_indicators/Rsi.md +++ b/docs/_indicators/Rsi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) in the lookback period. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Slope.md b/docs/_indicators/Slope.md index 96dbe66c..b629df58 100644 --- a/docs/_indicators/Slope.md +++ b/docs/_indicators/Slope.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) for the linear regression. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Sma.md b/docs/_indicators/Sma.md index c80173fb..8e9dc706 100644 --- a/docs/_indicators/Sma.md +++ b/docs/_indicators/Sma.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the lookback window. Must be greater than 0. | `candle_part` | CandlePart, *default CandlePart.CLOSE* | Specify candle part to evaluate. See [CandlePart options](#candlepart-options) below. diff --git a/docs/_indicators/Smi.md b/docs/_indicators/Smi.md index 68091fde..03980190 100644 --- a/docs/_indicators/Smi.md +++ b/docs/_indicators/Smi.md @@ -13,10 +13,10 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) -| `lookback_periods` | int | Lookback period (`N`) for the stochastic. Must be greater than 0. -| `first_smooth_periods` | int | First smoothing factor lookback. Must be greater than 0. -| `second_smooth_periods` | int | Second smoothing factor lookback. Must be greater than 0. +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame +| `lookback_periods` | int, *default 13* | Lookback period (`N`) for the stochastic. Must be greater than 0. +| `first_smooth_periods` | int, *default 25* | First smoothing factor lookback. Must be greater than 0. +| `second_smooth_periods` | int, *default 2* | Second smoothing factor lookback. Must be greater than 0. | `signal_periods` | int, *default 3* | EMA of SMI lookback periods. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Smma.md b/docs/_indicators/Smma.md index 7cda3cbd..a73e75b0 100644 --- a/docs/_indicators/Smma.md +++ b/docs/_indicators/Smma.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/StarcBands.md b/docs/_indicators/StarcBands.md index a99af437..e32c5b99 100644 --- a/docs/_indicators/StarcBands.md +++ b/docs/_indicators/StarcBands.md @@ -13,10 +13,10 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) -| `sma_periods` | int, *default 20* | Number of lookback periods (`S`) for the center line moving average. Must be greater than 1 to calculate and is typically between 5 and 10. -| `multiplier` | float, *default 2.0* | ATR Multiplier. Must be greater than 0. Default is 2. -| `atr_periods` | int, *default 10* | Number of lookback periods (`A`) for the Average True Range. Must be greater than 1 to calculate and is typically the same value as `sma_periods`. Default is 10. +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame +| `sma_periods` | int | Number of lookback periods (`S`) for the center line moving average. Must be greater than 1 to calculate and is typically between 5 and 10. +| `multiplier` | float, *default 2.0* | ATR Multiplier. Must be greater than 0. +| `atr_periods` | int, *default 10* | Number of lookback periods (`A`) for the Average True Range. Must be greater than 1 to calculate and is typically the same value as `sma_periods`. ### Historical quotes requirements @@ -69,7 +69,7 @@ results = indicators.get_starc_bands(quotes, 20, 2.0, 10) ## About {{ page.title }} -Created by Manning Stoller, [Stoller Average Range Channel (STARC) Bands](https://www.investopedia.com/terms/s/starc.asp), are based on an SMA centerline and ATR band widths. See also [Keltner Channels](../Keltner#content) for an EMA centerline equivalent. +Created by Manning Stoller, the [Stoller Average Range Channel (STARC) Bands](https://www.investopedia.com/terms/s/starc.asp), are price ranges based on an SMA centerline and ATR band widths. See also [Keltner Channels](../Keltner#content) for an EMA centerline equivalent. [[Discuss] 💬]({{site.dotnet.repo}}/discussions/292 "Community discussion about this indicator") ![image]({{site.dotnet.charts}}/StarcBands.png) diff --git a/docs/_indicators/Stc.md b/docs/_indicators/Stc.md index 71b83b2c..54dace7e 100644 --- a/docs/_indicators/Stc.md +++ b/docs/_indicators/Stc.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `cycle_periods` | int, *default 10* | Number of periods (`C`) for the Trend Cycle. Must be greater than or equal to 0. | `fast_periods` | int, *default 23* | Number of periods (`F`) for the faster moving average. Must be greater than 0. | `slow_periods` | int, *default 50* | Number of periods (`S`) for the slower moving average. Must be greater than `fast_periods`. diff --git a/docs/_indicators/StdDev.md b/docs/_indicators/StdDev.md index c6ddc1ae..12630b3f 100644 --- a/docs/_indicators/StdDev.md +++ b/docs/_indicators/StdDev.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the lookback period. Must be greater than 1 to calculate; however we suggest a larger period for statistically appropriate sample size. | `sma_periods` | int, Optional | Number of periods in the moving average of `Stdev`. Must be greater than 0, if specified. diff --git a/docs/_indicators/StdDevChannels.md b/docs/_indicators/StdDevChannels.md index e0cb0052..08c8886f 100644 --- a/docs/_indicators/StdDevChannels.md +++ b/docs/_indicators/StdDevChannels.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, Optional, *default 20* | Size (`N`) of the evaluation window. Must be `None` or greater than 1 to calculate. A `None` value will produce a full `quotes` evaluation window ([see below](#alternative-depiction-for-full-quotes-variant)). | `standard_deviations` | int, *default 2* | Width of bands. Standard deviations (`D`) from the regression line. Must be greater than 0. Default is 2. diff --git a/docs/_indicators/Stoch.md b/docs/_indicators/Stoch.md index b5d69061..7950a5be 100644 --- a/docs/_indicators/Stoch.md +++ b/docs/_indicators/Stoch.md @@ -14,7 +14,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Lookback period (`N`) for the oscillator (%K). Must be greater than 0. | `signal_periods` | int, *default 3* | Smoothing period for the signal (%D). Must be greater than 0. | `smooth_periods` | int, *default 3* | Smoothing period (`S`) for the Oscillator (%K). "Slow" stochastic uses 3, "Fast" stochastic uses 1. Must be greater than 0. diff --git a/docs/_indicators/StochRsi.md b/docs/_indicators/StochRsi.md index 53fd968a..37d3d620 100644 --- a/docs/_indicators/StochRsi.md +++ b/docs/_indicators/StochRsi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `rsi_periods` | int | Number of periods (`R`) in the lookback period. Must be greater than 0. Standard is 14. | `stoch_periods` | int | Number of periods (`S`) in the lookback period. Must be greater than 0. Typically the same value as `rsi_periods`. | `signal_periods` | int | Number of periods (`G`) in the signal line (SMA of the StochRSI). Must be greater than 0. Typically 3-5. diff --git a/docs/_indicators/SuperTrend.md b/docs/_indicators/SuperTrend.md index f1824f6f..c0fe3794 100644 --- a/docs/_indicators/SuperTrend.md +++ b/docs/_indicators/SuperTrend.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 10* | Number of periods (`N`) for the ATR evaluation. Must be greater than 1 and is usually set between 7 and 14. | `multiplier` | float, *default 3* | Multiplier sets the ATR band width. Must be greater than 0 and is usually set around 2 to 3. diff --git a/docs/_indicators/T3.md b/docs/_indicators/T3.md index 887ccda8..a00b30c7 100644 --- a/docs/_indicators/T3.md +++ b/docs/_indicators/T3.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 5* | Number of periods (`N`) for the EMA smoothing. Must be greater than 0 and is usually less than 63. | `volume_factor` | float, *default 0.7* | Size of the Volume Factor. Must be greater than 0 and is usually less than 2. diff --git a/docs/_indicators/Tema.md b/docs/_indicators/Tema.md index 0af0887a..3339d917 100644 --- a/docs/_indicators/Tema.md +++ b/docs/_indicators/Tema.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Trix.md b/docs/_indicators/Trix.md index 6ab8e2e8..d4221461 100644 --- a/docs/_indicators/Trix.md +++ b/docs/_indicators/Trix.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in each of the the exponential moving averages. Must be greater than 0. | `signal_periods` | int, Optional | Number of periods in the moving average of TRIX. Must be greater than 0, if specified. diff --git a/docs/_indicators/Tsi.md b/docs/_indicators/Tsi.md index ecc81db1..45c808ec 100644 --- a/docs/_indicators/Tsi.md +++ b/docs/_indicators/Tsi.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 25* | Number of periods (`N`) for the first EMA. Must be greater than 0. | `smooth_periods` | int, *default 13* | Number of periods (`M`) for the second smoothing. Must be greater than 0. | `signal_periods` | int, *default 7* | Number of periods (`S`) in the TSI moving average. Must be greater than or equal to 0. diff --git a/docs/_indicators/UlcerIndex.md b/docs/_indicators/UlcerIndex.md index 64f27ffb..f0b9705c 100644 --- a/docs/_indicators/UlcerIndex.md +++ b/docs/_indicators/UlcerIndex.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) for review. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/Ultimate.md b/docs/_indicators/Ultimate.md index ee926ae0..bea80ecf 100644 --- a/docs/_indicators/Ultimate.md +++ b/docs/_indicators/Ultimate.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `short_periods` | int, *default 7* | Number of periods (`S`) in the short lookback. Must be greater than 0. | `middle_periods` | int, *default 14* | Number of periods (`M`) in the middle lookback. Must be greater than `S`. | `long_periods` | int, *default 28* | Number of periods (`L`) in the long lookback. Must be greater than `M`. diff --git a/docs/_indicators/VolatilityStop.md b/docs/_indicators/VolatilityStop.md index f4aadbc5..fd2e9204 100644 --- a/docs/_indicators/VolatilityStop.md +++ b/docs/_indicators/VolatilityStop.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 7* | Number of periods (`N`) ATR lookback window. Must be greater than 1. | `multiplier` | float, *default 3* | ATR multiplier for the offset. Must be greater than 0. diff --git a/docs/_indicators/Vortex.md b/docs/_indicators/Vortex.md index 15b9cceb..7b6aad5e 100644 --- a/docs/_indicators/Vortex.md +++ b/docs/_indicators/Vortex.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) to consider. Must be greater than 1 and is usually between 14 and 30. ### Historical quotes requirements diff --git a/docs/_indicators/Vwap.md b/docs/_indicators/Vwap.md index 106bb5de..ad0c8972 100644 --- a/docs/_indicators/Vwap.md +++ b/docs/_indicators/Vwap.md @@ -15,7 +15,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `start` | datetime, Optional | The anchor date used to start the VWAP accumulation. The earliest date in `quotes` is used when not provided. | `year`, `month`, `day`, `hour`, `minute`| int, Optional | The anchor date used to start the VWAP accumulation. The earliest date in `quotes` is used when not provided. diff --git a/docs/_indicators/Vwma.md b/docs/_indicators/Vwma.md index 83d694ef..4573e79c 100644 --- a/docs/_indicators/Vwma.md +++ b/docs/_indicators/Vwma.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. ### Historical quotes requirements diff --git a/docs/_indicators/WilliamsR.md b/docs/_indicators/WilliamsR.md index 6ebf8a8f..c6d73ad6 100644 --- a/docs/_indicators/WilliamsR.md +++ b/docs/_indicators/WilliamsR.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int, *default 14* | Number of periods (`N`) in the lookback period. Must be greater than 0. Default is 14. ### Historical quotes requirements diff --git a/docs/_indicators/Wma.md b/docs/_indicators/Wma.md index f39388db..6625c24f 100644 --- a/docs/_indicators/Wma.md +++ b/docs/_indicators/Wma.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0. | `candle_part` | CandlePart, *default CandlePart.CLOSE* | Specify candle part to evaluate. See [CandlePart options](#candlepart-options) below. diff --git a/docs/_indicators/ZigZag.md b/docs/_indicators/ZigZag.md index f61dda5a..e2fc83ae 100644 --- a/docs/_indicators/ZigZag.md +++ b/docs/_indicators/ZigZag.md @@ -13,7 +13,7 @@ layout: indicator | name | type | notes | -- |-- |-- -| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [Need help with pandas.DataFrame?]({{site.baseurl}}/guide/#using-pandasdataframe) +| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes).
• [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame | `end_type` | EndType, *default EndType.CLOSE* | Determines whether `close` or `high/low` are used to measure percent change. See [EndType options](#endtype-options) below. | `percent_change` | float, *default 5* | Percent change required to establish a line endpoint. Example: 3.5% would be entered as 3.5 (not 0.035). Must be greater than 0. Typical values range from 3 to 10. diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index 3241e599..ed76dc6e 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -284,6 +284,10 @@ a { span.indicator-syntax { font-size: 1.25rem; } + + span.qna-dataframe { + font-size: 0.8rem; + } // END CUSTOM pre { diff --git a/docs/contributing.md b/docs/contributing.md index 6fec9e1d..60713584 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -35,13 +35,13 @@ We have different places to take issues by its category. If you are reporting a bug or suspect a problem, please submit an issue with a detailed description of the problem + include steps to reproduce, code samples, and any reference materials. -:wrench: [Report bugs](https://github.com/DaveSkender/Stock.Indicators.Python/issues/new?labels=bug&template=bug_report.md) +🔧 [Report bugs](https://github.com/DaveSkender/Stock.Indicators.Python/issues/new?labels=bug&template=bug_report.md) ### Feature Request For new features, submit an issue with the `enhancement` label. -:bulb: [Request features](https://github.com/DaveSkender/Stock.Indicators.Python/issues/new?labels=enhancement&template=feature_request.md) +💡 [Request features](https://github.com/DaveSkender/Stock.Indicators.Python/issues/new?labels=enhancement&template=feature_request.md) ## Project management diff --git a/docs/pages/home.md b/docs/pages/home.md index fa35d8eb..f08b7c87 100644 --- a/docs/pages/home.md +++ b/docs/pages/home.md @@ -9,12 +9,13 @@ lazy-images: true

- + - + + + +