Skip to content

Commit 6ea5a20

Browse files
committed
Update docs for move to TA-Lib organization.
1 parent d24c21c commit 6ea5a20

File tree

11 files changed

+26
-92
lines changed

11 files changed

+26
-92
lines changed

docs/abstract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,6 @@ ma20 = SMA(20)
9898
```
9999

100100
For more details, take a look at the
101-
[code](https://github.com/mrjbq7/ta-lib/blob/master/talib/abstract.pyx#L46).
101+
[code](https://github.com/ta-lib/ta-lib-python/blob/master/talib/abstract.pyx#L46).
102102

103103
[Documentation Index](doc_index.md)

docs/func_groups/cycle_indicators.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,30 @@ NOTE: The ``HT_DCPERIOD`` function has an unstable period.
55
real = HT_DCPERIOD(close)
66
```
77

8-
Learn more about the Hilbert Transform - Dominant Cycle Period at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPERIOD.htm).
98
### HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase
109
NOTE: The ``HT_DCPHASE`` function has an unstable period.
1110
```python
1211
real = HT_DCPHASE(close)
1312
```
1413

15-
Learn more about the Hilbert Transform - Dominant Cycle Phase at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPHASE.htm).
1614
### HT_PHASOR - Hilbert Transform - Phasor Components
1715
NOTE: The ``HT_PHASOR`` function has an unstable period.
1816
```python
1917
inphase, quadrature = HT_PHASOR(close)
2018
```
2119

22-
Learn more about the Hilbert Transform - Phasor Components at [tadoc.org](http://www.tadoc.org/indicator/HT_PHASOR.htm).
2320
### HT_SINE - Hilbert Transform - SineWave
2421
NOTE: The ``HT_SINE`` function has an unstable period.
2522
```python
2623
sine, leadsine = HT_SINE(close)
2724
```
2825

29-
Learn more about the Hilbert Transform - SineWave at [tadoc.org](http://www.tadoc.org/indicator/HT_SINE.htm).
3026
### HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode
3127
NOTE: The ``HT_TRENDMODE`` function has an unstable period.
3228
```python
3329
integer = HT_TRENDMODE(close)
3430
```
3531

36-
Learn more about the Hilbert Transform - Trend vs Cycle Mode at [tadoc.org](http://www.tadoc.org/indicator/HT_TRENDMODE.htm).
3732

3833
[Documentation Index](../doc_index.html)
3934
[FLOAT_RIGHTAll Function Groups](../funcs.html)

docs/func_groups/momentum_indicators.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,64 +5,54 @@ NOTE: The ``ADX`` function has an unstable period.
55
real = ADX(high, low, close, timeperiod=14)
66
```
77

8-
Learn more about the Average Directional Movement Index at [tadoc.org](http://www.tadoc.org/indicator/ADX.htm).
98
### ADXR - Average Directional Movement Index Rating
109
NOTE: The ``ADXR`` function has an unstable period.
1110
```python
1211
real = ADXR(high, low, close, timeperiod=14)
1312
```
1413

15-
Learn more about the Average Directional Movement Index Rating at [tadoc.org](http://www.tadoc.org/indicator/ADXR.htm).
1614
### APO - Absolute Price Oscillator
1715
```python
1816
real = APO(close, fastperiod=12, slowperiod=26, matype=0)
1917
```
2018

21-
Learn more about the Absolute Price Oscillator at [tadoc.org](http://www.tadoc.org/indicator/APO.htm).
2219
### AROON - Aroon
2320
```python
2421
aroondown, aroonup = AROON(high, low, timeperiod=14)
2522
```
2623

27-
Learn more about the Aroon at [tadoc.org](http://www.tadoc.org/indicator/AROON.htm).
2824
### AROONOSC - Aroon Oscillator
2925
```python
3026
real = AROONOSC(high, low, timeperiod=14)
3127
```
3228

33-
Learn more about the Aroon Oscillator at [tadoc.org](http://www.tadoc.org/indicator/AROONOSC.htm).
3429
### BOP - Balance Of Power
3530
```python
3631
real = BOP(open, high, low, close)
3732
```
3833

39-
Learn more about the Balance Of Power at [tadoc.org](http://www.tadoc.org/indicator/BOP.htm).
4034
### CCI - Commodity Channel Index
4135
```python
4236
real = CCI(high, low, close, timeperiod=14)
4337
```
4438

45-
Learn more about the Commodity Channel Index at [tadoc.org](http://www.tadoc.org/indicator/CCI.htm).
4639
### CMO - Chande Momentum Oscillator
4740
NOTE: The ``CMO`` function has an unstable period.
4841
```python
4942
real = CMO(close, timeperiod=14)
5043
```
5144

52-
Learn more about the Chande Momentum Oscillator at [tadoc.org](http://www.tadoc.org/indicator/CMO.htm).
5345
### DX - Directional Movement Index
5446
NOTE: The ``DX`` function has an unstable period.
5547
```python
5648
real = DX(high, low, close, timeperiod=14)
5749
```
5850

59-
Learn more about the Directional Movement Index at [tadoc.org](http://www.tadoc.org/indicator/DX.htm).
6051
### MACD - Moving Average Convergence/Divergence
6152
```python
6253
macd, macdsignal, macdhist = MACD(close, fastperiod=12, slowperiod=26, signalperiod=9)
6354
```
6455

65-
Learn more about the Moving Average Convergence/Divergence at [tadoc.org](http://www.tadoc.org/indicator/MACD.htm).
6656
### MACDEXT - MACD with controllable MA type
6757
```python
6858
macd, macdsignal, macdhist = MACDEXT(close, fastperiod=12, fastmatype=0, slowperiod=26, slowmatype=0, signalperiod=9, signalmatype=0)
@@ -79,115 +69,97 @@ NOTE: The ``MFI`` function has an unstable period.
7969
real = MFI(high, low, close, volume, timeperiod=14)
8070
```
8171

82-
Learn more about the Money Flow Index at [tadoc.org](http://www.tadoc.org/indicator/MFI.htm).
8372
### MINUS_DI - Minus Directional Indicator
8473
NOTE: The ``MINUS_DI`` function has an unstable period.
8574
```python
8675
real = MINUS_DI(high, low, close, timeperiod=14)
8776
```
8877

89-
Learn more about the Minus Directional Indicator at [tadoc.org](http://www.tadoc.org/indicator/MINUS_DI.htm).
9078
### MINUS_DM - Minus Directional Movement
9179
NOTE: The ``MINUS_DM`` function has an unstable period.
9280
```python
9381
real = MINUS_DM(high, low, timeperiod=14)
9482
```
9583

96-
Learn more about the Minus Directional Movement at [tadoc.org](http://www.tadoc.org/indicator/MINUS_DM.htm).
9784
### MOM - Momentum
9885
```python
9986
real = MOM(close, timeperiod=10)
10087
```
10188

102-
Learn more about the Momentum at [tadoc.org](http://www.tadoc.org/indicator/MOM.htm).
10389
### PLUS_DI - Plus Directional Indicator
10490
NOTE: The ``PLUS_DI`` function has an unstable period.
10591
```python
10692
real = PLUS_DI(high, low, close, timeperiod=14)
10793
```
10894

109-
Learn more about the Plus Directional Indicator at [tadoc.org](http://www.tadoc.org/indicator/PLUS_DI.htm).
11095
### PLUS_DM - Plus Directional Movement
11196
NOTE: The ``PLUS_DM`` function has an unstable period.
11297
```python
11398
real = PLUS_DM(high, low, timeperiod=14)
11499
```
115100

116-
Learn more about the Plus Directional Movement at [tadoc.org](http://www.tadoc.org/indicator/PLUS_DM.htm).
117101
### PPO - Percentage Price Oscillator
118102
```python
119103
real = PPO(close, fastperiod=12, slowperiod=26, matype=0)
120104
```
121105

122-
Learn more about the Percentage Price Oscillator at [tadoc.org](http://www.tadoc.org/indicator/PPO.htm).
123106
### ROC - Rate of change : ((price/prevPrice)-1)*100
124107
```python
125108
real = ROC(close, timeperiod=10)
126109
```
127110

128-
Learn more about the Rate of change : ((price/prevPrice)-1)*100 at [tadoc.org](http://www.tadoc.org/indicator/ROC.htm).
129111
### ROCP - Rate of change Percentage: (price-prevPrice)/prevPrice
130112
```python
131113
real = ROCP(close, timeperiod=10)
132114
```
133115

134-
Learn more about the Rate of change Percentage: (price-prevPrice)/prevPrice at [tadoc.org](http://www.tadoc.org/indicator/ROCP.htm).
135116
### ROCR - Rate of change ratio: (price/prevPrice)
136117
```python
137118
real = ROCR(close, timeperiod=10)
138119
```
139120

140-
Learn more about the Rate of change ratio: (price/prevPrice) at [tadoc.org](http://www.tadoc.org/indicator/ROCR.htm).
141121
### ROCR100 - Rate of change ratio 100 scale: (price/prevPrice)*100
142122
```python
143123
real = ROCR100(close, timeperiod=10)
144124
```
145125

146-
Learn more about the Rate of change ratio 100 scale: (price/prevPrice)*100 at [tadoc.org](http://www.tadoc.org/indicator/ROCR100.htm).
147126
### RSI - Relative Strength Index
148127
NOTE: The ``RSI`` function has an unstable period.
149128
```python
150129
real = RSI(close, timeperiod=14)
151130
```
152131

153-
Learn more about the Relative Strength Index at [tadoc.org](http://www.tadoc.org/indicator/RSI.htm).
154132
### STOCH - Stochastic
155133
```python
156134
slowk, slowd = STOCH(high, low, close, fastk_period=5, slowk_period=3, slowk_matype=0, slowd_period=3, slowd_matype=0)
157135
```
158136

159-
Learn more about the Stochastic at [tadoc.org](http://www.tadoc.org/indicator/STOCH.htm).
160137
### STOCHF - Stochastic Fast
161138
```python
162139
fastk, fastd = STOCHF(high, low, close, fastk_period=5, fastd_period=3, fastd_matype=0)
163140
```
164141

165-
Learn more about the Stochastic Fast at [tadoc.org](http://www.tadoc.org/indicator/STOCHF.htm).
166142
### STOCHRSI - Stochastic Relative Strength Index
167143
NOTE: The ``STOCHRSI`` function has an unstable period.
168144
```python
169145
fastk, fastd = STOCHRSI(close, timeperiod=14, fastk_period=5, fastd_period=3, fastd_matype=0)
170146
```
171147

172-
Learn more about the Stochastic Relative Strength Index at [tadoc.org](http://www.tadoc.org/indicator/STOCHRSI.htm).
173148
### TRIX - 1-day Rate-Of-Change (ROC) of a Triple Smooth EMA
174149
```python
175150
real = TRIX(close, timeperiod=30)
176151
```
177152

178-
Learn more about the 1-day Rate-Of-Change (ROC) of a Triple Smooth EMA at [tadoc.org](http://www.tadoc.org/indicator/TRIX.htm).
179153
### ULTOSC - Ultimate Oscillator
180154
```python
181155
real = ULTOSC(high, low, close, timeperiod1=7, timeperiod2=14, timeperiod3=28)
182156
```
183157

184-
Learn more about the Ultimate Oscillator at [tadoc.org](http://www.tadoc.org/indicator/ULTOSC.htm).
185158
### WILLR - Williams' %R
186159
```python
187160
real = WILLR(high, low, close, timeperiod=14)
188161
```
189162

190-
Learn more about the Williams' %R at [tadoc.org](http://www.tadoc.org/indicator/WILLR.htm).
191163

192164
[Documentation Index](../doc_index.html)
193165
[FLOAT_RIGHTAll Function Groups](../funcs.html)

docs/func_groups/overlap_studies.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,29 @@
44
upperband, middleband, lowerband = BBANDS(close, timeperiod=5, nbdevup=2, nbdevdn=2, matype=0)
55
```
66

7-
Learn more about the Bollinger Bands at [tadoc.org](http://www.tadoc.org/indicator/BBANDS.htm).
87
### DEMA - Double Exponential Moving Average
98
```python
109
real = DEMA(close, timeperiod=30)
1110
```
1211

13-
Learn more about the Double Exponential Moving Average at [tadoc.org](http://www.tadoc.org/indicator/DEMA.htm).
1412
### EMA - Exponential Moving Average
1513
NOTE: The ``EMA`` function has an unstable period.
1614
```python
1715
real = EMA(close, timeperiod=30)
1816
```
1917

20-
Learn more about the Exponential Moving Average at [tadoc.org](http://www.tadoc.org/indicator/EMA.htm).
2118
### HT_TRENDLINE - Hilbert Transform - Instantaneous Trendline
2219
NOTE: The ``HT_TRENDLINE`` function has an unstable period.
2320
```python
2421
real = HT_TRENDLINE(close)
2522
```
2623

27-
Learn more about the Hilbert Transform - Instantaneous Trendline at [tadoc.org](http://www.tadoc.org/indicator/HT_TRENDLINE.htm).
2824
### KAMA - Kaufman Adaptive Moving Average
2925
NOTE: The ``KAMA`` function has an unstable period.
3026
```python
3127
real = KAMA(close, timeperiod=30)
3228
```
3329

34-
Learn more about the Kaufman Adaptive Moving Average at [tadoc.org](http://www.tadoc.org/indicator/KAMA.htm).
3530
### MA - Moving average
3631
```python
3732
real = MA(close, timeperiod=30, matype=0)
@@ -43,7 +38,6 @@ NOTE: The ``MAMA`` function has an unstable period.
4338
mama, fama = MAMA(close, fastlimit=0, slowlimit=0)
4439
```
4540

46-
Learn more about the MESA Adaptive Moving Average at [tadoc.org](http://www.tadoc.org/indicator/MAMA.htm).
4741
### MAVP - Moving average with variable period
4842
```python
4943
real = MAVP(close, periods, minperiod=2, maxperiod=30, matype=0)
@@ -54,19 +48,16 @@ real = MAVP(close, periods, minperiod=2, maxperiod=30, matype=0)
5448
real = MIDPOINT(close, timeperiod=14)
5549
```
5650

57-
Learn more about the MidPoint over period at [tadoc.org](http://www.tadoc.org/indicator/MIDPOINT.htm).
5851
### MIDPRICE - Midpoint Price over period
5952
```python
6053
real = MIDPRICE(high, low, timeperiod=14)
6154
```
6255

63-
Learn more about the Midpoint Price over period at [tadoc.org](http://www.tadoc.org/indicator/MIDPRICE.htm).
6456
### SAR - Parabolic SAR
6557
```python
6658
real = SAR(high, low, acceleration=0, maximum=0)
6759
```
6860

69-
Learn more about the Parabolic SAR at [tadoc.org](http://www.tadoc.org/indicator/SAR.htm).
7061
### SAREXT - Parabolic SAR - Extended
7162
```python
7263
real = SAREXT(high, low, startvalue=0, offsetonreverse=0, accelerationinitlong=0, accelerationlong=0, accelerationmaxlong=0, accelerationinitshort=0, accelerationshort=0, accelerationmaxshort=0)
@@ -77,32 +68,27 @@ real = SAREXT(high, low, startvalue=0, offsetonreverse=0, accelerationinitlong=0
7768
real = SMA(close, timeperiod=30)
7869
```
7970

80-
Learn more about the Simple Moving Average at [tadoc.org](http://www.tadoc.org/indicator/SMA.htm).
8171
### T3 - Triple Exponential Moving Average (T3)
8272
NOTE: The ``T3`` function has an unstable period.
8373
```python
8474
real = T3(close, timeperiod=5, vfactor=0)
8575
```
8676

87-
Learn more about the Triple Exponential Moving Average (T3) at [tadoc.org](http://www.tadoc.org/indicator/T3.htm).
8877
### TEMA - Triple Exponential Moving Average
8978
```python
9079
real = TEMA(close, timeperiod=30)
9180
```
9281

93-
Learn more about the Triple Exponential Moving Average at [tadoc.org](http://www.tadoc.org/indicator/TEMA.htm).
9482
### TRIMA - Triangular Moving Average
9583
```python
9684
real = TRIMA(close, timeperiod=30)
9785
```
9886

99-
Learn more about the Triangular Moving Average at [tadoc.org](http://www.tadoc.org/indicator/TRIMA.htm).
10087
### WMA - Weighted Moving Average
10188
```python
10289
real = WMA(close, timeperiod=30)
10390
```
10491

105-
Learn more about the Weighted Moving Average at [tadoc.org](http://www.tadoc.org/indicator/WMA.htm).
10692

10793
[Documentation Index](../doc_index.html)
10894
[FLOAT_RIGHTAll Function Groups](../funcs.html)

docs/func_groups/price_transform.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,21 @@
44
real = AVGPRICE(open, high, low, close)
55
```
66

7-
Learn more about the Average Price at [tadoc.org](http://www.tadoc.org/indicator/AVGPRICE.htm).
87
### MEDPRICE - Median Price
98
```python
109
real = MEDPRICE(high, low)
1110
```
1211

13-
Learn more about the Median Price at [tadoc.org](http://www.tadoc.org/indicator/MEDPRICE.htm).
1412
### TYPPRICE - Typical Price
1513
```python
1614
real = TYPPRICE(high, low, close)
1715
```
1816

19-
Learn more about the Typical Price at [tadoc.org](http://www.tadoc.org/indicator/TYPPRICE.htm).
2017
### WCLPRICE - Weighted Close Price
2118
```python
2219
real = WCLPRICE(high, low, close)
2320
```
2421

25-
Learn more about the Weighted Close Price at [tadoc.org](http://www.tadoc.org/indicator/WCLPRICE.htm).
2622

2723
[Documentation Index](../doc_index.html)
2824
[FLOAT_RIGHTAll Function Groups](../funcs.html)

0 commit comments

Comments
 (0)