add charts to docs (#135)

DaveSkender · Sep 14, 2020 · 887a743 · 887a743
1 parent 9bcc950
commit 887a743
Show file tree

Hide file tree

Showing 68 changed files with 73 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -14,8 +14,8 @@ Explore more information:
 
 - [List of indicators and overlays](https://daveskender.github.io/Stock.Indicators/docs/INDICATORS.html)
 - [Getting started](#getting-started)
-- [Guide and Pro tips](docs/GUIDE.md)
-- [Contributing guidelines](docs/CONTRIBUTING.md)
+- [Guide and Pro tips](https://daveskender.github.io/Stock.Indicators/docs/GUIDE.html)
+- [Contributing guidelines](docs/CONTRIBUTING.md#content)
 - [Release notes](https://github.com/DaveSkender/Stock.Indicators/releases)
 - [Demo site](https://stock-charts.azurewebsites.net) (a stock chart that uses this library)
 - [Contact us](#contact-us)
@@ -57,7 +57,7 @@ See [individual indicator pages](https://daveskender.github.io/Stock.Indicators/
 
 [![board status](https://dev.azure.com/skender/5123ca47-74f2-4d67-a5d4-c4d90b8d670a/69f29c08-2257-4429-9cea-1629abcd3064/_apis/work/boardbadge/a1dfc6ae-7836-4b56-a849-9a48698252c2)](https://dev.azure.com/skender/5123ca47-74f2-4d67-a5d4-c4d90b8d670a/_boards/board/t/69f29c08-2257-4429-9cea-1629abcd3064/Microsoft.RequirementCategory/)
 
-This NuGet package is an open-source project.  If you want to report or contribute bug fixes, new indicators, or feature requests, please review our [contributing guidelines](docs/CONTRIBUTING.md).
+This NuGet package is an open-source project.  If you want to report or contribute bug fixes, new indicators, or feature requests, please review our [contributing guidelines](docs/CONTRIBUTING.md#content).
 
 ## Contact us
 

diff --git a/indicators/Adl/README.md b/indicators/Adl/README.md
@@ -2,6 +2,8 @@
 
 A rolling accumulation of Chaikin Money Flow Volume.  [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:accumulation_distribution_line)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<AdlResult> results = Indicator.GetAdl(history);  

diff --git a/indicators/Adl/chart.png b/indicators/Adl/chart.png
diff --git a/indicators/Aroon/README.md b/indicators/Aroon/README.md
@@ -3,6 +3,8 @@
 Aroon is a simple oscillator view of how long the new high or low price occured over a lookback period.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:aroon)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<AroonResult> results = Indicator.GetAroon(history, lookbackPeriod);  

diff --git a/indicators/Aroon/chart.png b/indicators/Aroon/chart.png
diff --git a/indicators/AvgDirectional/README.md b/indicators/AvgDirectional/README.md
@@ -3,6 +3,8 @@
 Measure of price directional movement.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:average_directional_index_adx)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<AdxResult> results = Indicator.GetAdx(history, lookbackPeriod);  

diff --git a/indicators/AvgDirectional/chart.png b/indicators/AvgDirectional/chart.png
diff --git a/indicators/AvgTrueRange/README.md b/indicators/AvgTrueRange/README.md
@@ -3,6 +3,8 @@
 Measure of volatility that captures gaps and limits between periods.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:average_true_range_atr)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<AtrResult> results = Indicator.GetAtr(history, lookbackPeriod);  

diff --git a/indicators/AvgTrueRange/chart.png b/indicators/AvgTrueRange/chart.png
diff --git a/indicators/Beta/README.md b/indicators/Beta/README.md
@@ -3,6 +3,8 @@
 Beta shows how strongly one stock responds to systemic volatility of the entire market.
 [More info ...](https://en.wikipedia.org/wiki/Beta_(finance))
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<BetaResult> results = Indicator.GetBeta(historyMarket, historyEval, lookbackPeriod);  

diff --git a/indicators/Beta/chart.png b/indicators/Beta/chart.png
diff --git a/indicators/BollingerBands/README.md b/indicators/BollingerBands/README.md
@@ -3,6 +3,8 @@
 Bollinger Bands indicate volatility and displays standard deviation boundary lines from moving average of Close price.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:bollinger_bands)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<BollingerBandsResult> results = Indicator.GetBollingerBands(history, lookbackPeriod, standardDeviation);  

diff --git a/indicators/BollingerBands/chart.png b/indicators/BollingerBands/chart.png
diff --git a/indicators/Cci/README.md b/indicators/Cci/README.md
@@ -3,6 +3,8 @@
 Oscillator depicting deviation from typical price range.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:commodity_channel_index_cci)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<CciResult> results = Indicator.GetCci(history, lookbackPeriod);  

diff --git a/indicators/Cci/chart.png b/indicators/Cci/chart.png
diff --git a/indicators/ChaikinMoneyFlow/README.md b/indicators/ChaikinMoneyFlow/README.md
@@ -3,6 +3,8 @@
 Chaikin Money Flow is the simple moving average of the Money Flow Volume over `N` lookback periods.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:chaikin_money_flow_cmf)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<CmfResult> results = Indicator.GetCmf(history, lookbackPeriod);  

diff --git a/indicators/ChaikinMoneyFlow/chart.png b/indicators/ChaikinMoneyFlow/chart.png
diff --git a/indicators/ChaikinOscillator/README.md b/indicators/ChaikinOscillator/README.md
@@ -3,6 +3,8 @@
 Chaikin Oscillator is the difference between fast and slow Exponential Moving Averages (EMA) of the Accumulation and Distribution Line (ADL).
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:chaikin_oscillator)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ChaikinOscResult> results = Indicator.GetChaikinOsc(history, fastPeriod, slowPeriod);  

diff --git a/indicators/ChaikinOscillator/chart.png b/indicators/ChaikinOscillator/chart.png
diff --git a/indicators/Chandelier/README.md b/indicators/Chandelier/README.md
@@ -3,6 +3,8 @@
 Chandelier Exit is typically used for stop-loss and can be computed for both long or short types.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:chandelier_exit)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ChandelierResult> results = Indicator.GetChandelier(history, lookbackPeriod, multiplier, type);  

diff --git a/indicators/Chandelier/chart.png b/indicators/Chandelier/chart.png
diff --git a/indicators/ConnorsRsi/README.md b/indicators/ConnorsRsi/README.md
@@ -3,6 +3,8 @@
 A composite oscillator that incorporates RSI, winning/losing streaks, and percentile gain metrics on scale of 0 to 100.
 [More info](https://alvarezquanttrading.com/wp-content/uploads/2016/05/ConnorsRSIGuidebook.pdf) and [analysis](https://alvarezquanttrading.com/blog/connorsrsi-analysis).
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ConnorsRsiResult> results = Indicator.GetConnorsRsi(history, rsiPeriod, streakPeriod, rankPeriod);  

diff --git a/indicators/ConnorsRsi/chart.png b/indicators/ConnorsRsi/chart.png
diff --git a/indicators/Correlation/README.md b/indicators/Correlation/README.md
@@ -3,6 +3,8 @@
 Correlation between two quote histories, based on Close price.  R-Squared (R&sup2;), Variance, and covariance are also output.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:correlation_coeffici)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<CorrResult> results = Indicator.GetCorr(historyA, historyB, lookbackPeriod);  

diff --git a/indicators/Correlation/chart.png b/indicators/Correlation/chart.png
diff --git a/indicators/Donchian/README.md b/indicators/Donchian/README.md
@@ -3,6 +3,8 @@
 Donchian Channels are derived from highed High and lowest Low values over a lookback period.
 [More info ...](https://en.wikipedia.org/wiki/Donchian_channel)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<DonchianResult> results = Indicator.GetDonchian(history, lookbackPeriod);  
@@ -32,7 +34,6 @@ The first `N-1` periods will have `null` values since there's not enough data to
 | `Centerline` | decimal | Simple average of Upper and Lower bands
 | `LowerBand` | decimal | Lower line is the lowest Low over `N` periods
 | `Width` | decimal | Width as percent of Centerline price.  `(UpperBand-LowerBand)/Centerline`
-| `IsDiverging` | bool | Upper and Lower bands are diverging.  `null` when `Width` is neither increase nor decreasing.
 
 ## Example
 

diff --git a/indicators/Donchian/chart.png b/indicators/Donchian/chart.png
diff --git a/indicators/Ema/README.md b/indicators/Ema/README.md
@@ -2,6 +2,8 @@
 
 Exponentially weighted moving average of the Close price over `N` periods.  More info on: [EMA](https://school.stockcharts.com/doku.php?id=technical_indicators:moving_averages) and [Double EMA](https://www.investopedia.com/terms/d/double-exponential-moving-average.asp)
 
+![image](chart.png)
+
 ```csharp
 // usage for EMA (standard)
 IEnumerable<EmaResult> results = Indicator.GetEma(history, lookbackPeriod);

diff --git a/indicators/Ema/chart.png b/indicators/Ema/chart.png
diff --git a/indicators/HeikinAshi/README.md b/indicators/HeikinAshi/README.md
@@ -2,6 +2,8 @@
 
 A modified candlestick pattern that uses prior day for smoothing.  [More info ...](https://school.stockcharts.com/doku.php?id=chart_analysis:heikin_ashi)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<HeikinAshiResult> results = Indicator.GetHeikinAshi(history);  

diff --git a/indicators/HeikinAshi/chart.png b/indicators/HeikinAshi/chart.png
diff --git a/indicators/Hma/README.md b/indicators/Hma/README.md
@@ -3,6 +3,8 @@
 HMA is a modified linear weighted average of `Close` price over `N` lookback periods that reduces lag.
 [More info ...](https://alanhull.com/hull-moving-average)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<HmaResult> results = Indicator.GetHma(history, lookbackPeriod);  

diff --git a/indicators/Hma/chart.png b/indicators/Hma/chart.png
diff --git a/indicators/Ichimoku/README.md b/indicators/Ichimoku/README.md
@@ -3,6 +3,8 @@
 The Ichimoku Cloud, also known as Ichimoku Kinkō Hyō, is a collection of indicators that depict support and resistance, momentum, and trend direction.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:ichimoku_cloud)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<IchimokuResult> results = Indicator.GetIchimoku(history, lookbackPeriod);  

diff --git a/indicators/Ichimoku/chart.png b/indicators/Ichimoku/chart.png
diff --git a/indicators/Keltner/README.md b/indicators/Keltner/README.md
@@ -3,6 +3,8 @@
 Keltner Channels are based on an EMA centerline and ATR band widths.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:keltner_channels)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<KeltnerResult> results = Indicator.GetKeltner(history, emaPeriod, multiplier, atrPeriod);  

diff --git a/indicators/Keltner/chart.png b/indicators/Keltner/chart.png
diff --git a/indicators/Macd/README.md b/indicators/Macd/README.md
@@ -3,6 +3,8 @@
 MACD is a simple oscillator view of two converging/diverging exponential moving averages.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:moving_average_convergence_divergence_macd)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<MacdResult> results = Indicator.GetMacd(history, fastPeriod, slowPeriod, signalPeriod);  

diff --git a/indicators/Macd/chart.png b/indicators/Macd/chart.png
diff --git a/indicators/Mfi/README.md b/indicators/Mfi/README.md
@@ -2,6 +2,8 @@
 
 A price-volume oscillator that shows buying and selling momentum.  [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:money_flow_index_mfi)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<MfiResult> results = Indicator.GetMfi(history,lookbackPeriod);

diff --git a/indicators/Mfi/chart.png b/indicators/Mfi/chart.png
diff --git a/indicators/Obv/README.md b/indicators/Obv/README.md
@@ -2,6 +2,8 @@
 
 A rolling accumulation of volume based on Close price direction.  [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:on_balance_volume_obv)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ObvResult> results = Indicator.GetObv(history);  

diff --git a/indicators/Obv/chart.png b/indicators/Obv/chart.png
diff --git a/indicators/ParabolicSar/README.md b/indicators/ParabolicSar/README.md
@@ -3,6 +3,8 @@
 Parabolic SAR (stop and reverse) is a price-time based indicator.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:parabolic_sar)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ParabolicSarResult> results = Indicator.GetParabolicSar(history, accelerationStep, maxAccelerationFactor);  
@@ -14,7 +16,7 @@ IEnumerable<ParabolicSarResult> results = Indicator.GetParabolicSar(history, acc
 | -- |-- |--
 | `history` | IEnumerable\<[Quote](../../docs/GUIDE.md#quote)\> | Historical Quotes data should be at any consistent frequency (day, hour, minute, etc).  Provide sufficient history to capture prior trend reversals, before your usage period.  At least two history records are required to calculate; however, we recommend at least 100 data points.
 | `accelerationStep` | decimal | Incremental step size.  Must be greater than 0.  Default is 0.02
-| `maxAccelerationFactor` | decimal | Maximimum step limit.  Must be greater than 0 and larger than `accelerationStep`.  Default is 0.2
+| `maxAccelerationFactor` | decimal | Maximimum step limit.  Must be greater than `accelerationStep`.  Default is 0.2
 
 NOTE: Initial Parabolic SAR values before the first reversal are not accurate and is excluded from the results.
 

diff --git a/indicators/ParabolicSar/chart.png b/indicators/ParabolicSar/chart.png
diff --git a/indicators/Pmo/README.md b/indicators/Pmo/README.md
@@ -3,6 +3,8 @@
 DecisionPoint Price Momentum Oscillator is double-smoothed ROC based momentum indicator.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:dppmo)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<PmoResult> results = Indicator.GetPmo(history, timePeriod, smoothingPeriod, signalPeriod);

diff --git a/indicators/Pmo/chart.png b/indicators/Pmo/chart.png
diff --git a/indicators/Roc/README.md b/indicators/Roc/README.md
@@ -3,6 +3,8 @@
 Rate of Change is the percent change of Close price over `N` lookback periods.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:rate_of_change_roc_and_momentum)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<RocResult> results = Indicator.GetRoc(history, lookbackPeriod);

diff --git a/indicators/Roc/chart.png b/indicators/Roc/chart.png
diff --git a/indicators/Rsi/README.md b/indicators/Rsi/README.md
@@ -4,6 +4,8 @@ Relative Strength Index measures strength of winning/losing streak over `N` look
 RSI values over 70 are considered overbought, while values under 30 are considered oversold.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:relative_strength_index_rsi)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<RsiResult> results = Indicator.GetRsi(history, lookbackPeriod);  

diff --git a/indicators/Rsi/chart.png b/indicators/Rsi/chart.png
diff --git a/indicators/Sma/README.md b/indicators/Sma/README.md
@@ -3,6 +3,8 @@
 Simple moving average is the average of Close price of `N` lookback periods.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:moving_averages)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<SmaResult> results = Indicator.GetSma(history, lookbackPeriod);  

diff --git a/indicators/Sma/chart.png b/indicators/Sma/chart.png
diff --git a/indicators/StandardDev/README.md b/indicators/StandardDev/README.md
@@ -3,6 +3,8 @@
 Standard Deviation of Close price over a lookback period.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:standard_deviation_volatility)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<StdDevResult> results = Indicator.GetStdDev(history, lookbackPeriod);  

diff --git a/indicators/StandardDev/chart.png b/indicators/StandardDev/chart.png
diff --git a/indicators/Stochastic/README.md b/indicators/Stochastic/README.md
@@ -3,6 +3,8 @@
 Stochastic Oscillator is a momentum indicator that looks back `N` periods to produce a scale of 0 to 100.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:stochastic_oscillator_fast_slow_and_full)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<StochResult> results = Indicator.GetStoch(history, lookbackPeriod, signalPeriod, smoothingPeriod);  

diff --git a/indicators/Stochastic/chart.png b/indicators/Stochastic/chart.png
diff --git a/indicators/StochasticRsi/README.md b/indicators/StochasticRsi/README.md
@@ -4,6 +4,8 @@ Stochastic interpretation of the Relative Strength Index.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:stochrsi)
 It is different from, and often confused with the more traditional [Stochastic Oscillator](../Stochastic/README.md)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<StochRsiResult> results = Indicator.GetStochRsi(history, rsiPeriod, stochPeriod, signalPeriod, smoothPeriod);

diff --git a/indicators/StochasticRsi/chart.png b/indicators/StochasticRsi/chart.png
diff --git a/indicators/UlcerIndex/README.md b/indicators/UlcerIndex/README.md
@@ -3,6 +3,8 @@
 UI is a measure of downside volatility over the lookback period.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:ulcer_index)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<UlcerIndexResult> results = Indicator.GetUlcerIndex(history, lookbackPeriod);  
@@ -28,7 +30,7 @@ The first `N-1` slow periods + signal period will have `null` values since there
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `UI` | decimal | The UlcerIndex value
+| `UI` | decimal | Ulcer Index
 
 ## Example
 
@@ -42,9 +44,9 @@ IEnumerable<UlcerIndexResult> results = Indicator.GetUlcerIndex(history,14);
 // use results as needed
 DateTime evalDate = DateTime.Parse("12/31/2018");
 UlcerIndexResult result = results.Where(x=>x.Date==evalDate).FirstOrDefault();
-Console.WriteLine("UlcerIndex on {0} was ${1}", result.Date, result.UI);
+Console.WriteLine("Ulcer Index on {0} was ${1}", result.Date, result.UI);
 ```
 
 ```bash
-UlcerIndex on 12/31/2018 was 5.73
+Ulcer Index on 12/31/2018 was 5.73
 ```
diff --git a/indicators/UlcerIndex/chart.png b/indicators/UlcerIndex/chart.png
diff --git a/indicators/WilliamR/README.md b/indicators/WilliamR/README.md
@@ -3,6 +3,8 @@
 William %R is a stochastic oscillator that looks back `N` periods to produce an indicator with scale of -100 to 0.  It is exactly the same as the Fast variant of [Stochastic Oscillator](../Stochastic/README.md), but with a different scaling.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:williams_r)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<WilliamResult> results = Indicator.GetWilliamR(history, lookbackPeriod);  

diff --git a/indicators/WilliamR/chart.png b/indicators/WilliamR/chart.png
diff --git a/indicators/Wma/README.md b/indicators/Wma/README.md
@@ -3,6 +3,8 @@
 Weighted moving average is the linear weighted average of `Close` price over `N` lookback periods.  This also called Linear Weighted Moving Average (LWMA).
 [More info ...](https://www.fidelity.com/learning-center/trading-investing/technical-analysis/technical-indicator-guide/wma)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<WmaResult> results = Indicator.GetWma(history, lookbackPeriod);  

diff --git a/indicators/Wma/chart.png b/indicators/Wma/chart.png
diff --git a/indicators/ZigZag/README.md b/indicators/ZigZag/README.md
@@ -3,6 +3,8 @@
 Zig Zag is a price chart overlay that simplifies the up and down movements and transitions based on a percent change smoothing threshold.
 [More info ...](https://school.stockcharts.com/doku.php?id=technical_indicators:zigzag)
 
+![image](chart.png)
+
 ```csharp
 // usage
 IEnumerable<ZigZagResult> results = Indicator.GetZigZag(history,type,percentChange);  

diff --git a/indicators/ZigZag/chart.png b/indicators/ZigZag/chart.png
diff --git a/tests/indicators/test data/History.xlsx b/tests/indicators/test data/History.xlsx