Adr, Ap, Atrp, Atrs, Vp, Vwap, Vwma

This commit is contained in:
Miha Kralj
2024-11-01 18:36:01 -07:00
parent 7c6b698c9a
commit f519594371
14 changed files with 1035 additions and 120 deletions
+6 -6
View File
@@ -1,24 +1,24 @@
* [Home](/)
* [Available Indicators](indicators/indicators.md)
* [List of Indicators](indicators/indicators.md)
* Introduction
* 🚧 Introduction
* [Overview]()
* [Features]()
* [Historical vs Real-time analysis](essays/realtime.md)
* Core Concepts
* 🚧 Core Concepts
* [Time Series Data Handling]()
* [Calculation classes]()
* [Presentation Classes]()
* QuanTAlib C# Library
* 🚧 QuanTAlib C# Library
* [Installation]()
* [Quick Start Guide]()
* [Usage Examples]()
* [Tests and Validation]()
* Quantower Charts
* 🚧 Quantower Charts
* [Installation]()
* [Quick Start Guide]()
* [Using VS Code for QuanTower coding](setup/vscode.md)
@@ -26,7 +26,7 @@
* [Creating Custom Indicators]()
* [Inspecting Quantower Internals]()
* [Available Indicators](indicators/indicators.md)
* [🚧 Available Indicators](indicators/indicators.md)
* Momentum
* [ADX - Average Directional Index](indicators/momentum/adx/description.md)
* [ADXR - Average Directional Index Rating](indicators/momentum/adxr/description.md)
+96 -13
View File
@@ -3,57 +3,140 @@
<head>
<meta charset="UTF-8">
<title>QuanTAlib Documentation</title>
<!-- Basic meta tags -->
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="description" content="Documentation for QuanTAlib, a quantitative technical analysis library">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/katex.min.css" integrity="sha384-3UiQGuEI4TTMaFmGIZumfRPtfKQ3trwQE2JgosJxCnGmQpL/lJdjpcHkaaFwHlcI" crossorigin="anonymous">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css" />
<!-- Stylesheets -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/katex.min.css"
integrity="sha384-3UiQGuEI4TTMaFmGIZumfRPtfKQ3trwQE2JgosJxCnGmQpL/lJdjpcHkaaFwHlcI"
crossorigin="anonymous">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
<style>
/* Target strong elements within tables */
table strong {
font-size: 120%;
display: inline-block; /* This helps with vertical alignment */
padding: 4px 0; /* Add some vertical padding for better spacing */
}
/* Optional: If you want to target just the section headers more specifically */
table tr:first-child strong,
table tr strong:first-child {
font-size: 120%;
color: #42b983; /* Optional: matches Docsify's default theme color */
}
/* Hide github corner */
.github-corner {
display: none !important;
}
.github-corner svg {
display: none !important;
}
</style>
</head>
<body>
<div id="app"></div>
<!-- Docsify Configuration -->
<script>
window.$docsify = {
// Basic settings
name: 'QuanTAlib',
repo: 'https://github.com/mihakralj/quantalib',
homepage: 'readme.md',
noCorner: true,
// Navigation settings
loadSidebar: true,
auto2top: true,
mergeNavbar: true,
sidebarDisplayLevel: 0,
// Performance settings
maxAge: 86400000,
paths: 'auto',
// Search settings
placeholder: 'Type to search',
noData: 'No Results!',
depth: 6,
hideOtherSidebarContent: false,
// Theme settings
themeable: {
readyTransition: true,
responsiveTables: true
},
// Math settings
latex: {
inlineMath: [['$', '$'], ['\\(', '\\)']],
displayMath: [['$$', '$$']]
},
// Markdown settings
markdown: {
smartypants: true,
renderer: {
table: function(header, body) {
if (header) return '<table class="docTable"><thead>' + header + '</thead><tbody>' + body + '</tbody></table>'
return '<table class="docTable"><tbody>' + body + '</tbody></table>'
}
}
},
// Content settings
executeScript: true,
externalLinkTarget: '_blank',
cornerExternalLinkTarget: '_blank',
relativePath: false,
// Table of Contents settings
toc: {
scope: '.markdown-section',
headings: 'h1, h2, h3, h4, h5, h6',
title: 'Table of Contents'
},
plugins: []
};
</script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js" integrity="sha384-KaHhgnx/OTLoJ4J33SSJsF4x1pk4I7q3s5ZOfIDHJYl6IG7Oyn2vNDsHiWJe46fD" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js" integrity="sha384-ibjVZCUwWPrRrNc9BNkbbJvtYmTh8GYDNQgj+2jQVNDudOFgSQWs+Es6JhdoTIvf" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js" integrity="sha384-lMHOyuqf3B/T/BgfYxUKprN0bdRf8KhVTE11w76Tvtze86XHVSDYzxqNGDGgIi9I" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js" integrity="sha384-LthJPBJ4RGco78kBY+EmKz5rmISZ5vrtAu3+l2ALQ2mrZHOe6Wyf6knyKjeC4cL6" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js" integrity="sha384-Vu4LjJ210wltbg1I3zl1f5n8qLSDr9GE7ij2JfiMbV64UCFP2RgFtG8W2Gh6Khwe" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js" integrity="sha384-uFEp18/1vv2dYlO64J2lOcnbhirAQZPtruqAZZ7PZYoXenm5c+tIs3AqSMjVMRe8" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js" integrity="sha384-fYBaBAsdPMjWt1AuA+txMoztHnl+zLgObSvwddIabbfUp+36gf/vNOKx88f37zix" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-tabs/dist/docsify-tabs.min.js" integrity="sha384-QA3IVKzXq6xcKR8yQJHgDbI1FcJiQ137Cuetl1VWzUxJ6BQ7ew0MMq5fg2HbFK1o" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-katex@1.4.3/dist/docsify-katex.js" integrity="sha384-M76M/x5vGyeoej1covQQifl7T945mY+qgzNVrM/urHMCYjP8tnMsx5WCdeLZ74UE" crossorigin="anonymous"></script>
<!-- Core Docsify -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"
integrity="sha384-KaHhgnx/OTLoJ4J33SSJsF4x1pk4I7q3s5ZOfIDHJYl6IG7Oyn2vNDsHiWJe46fD"
crossorigin="anonymous"></script>
<!-- Added marked.js for better markdown parsing -->
<script src="//cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<!-- Plugins -->
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"
integrity="sha384-ibjVZCUwWPrRrNc9BNkbbJvtYmTh8GYDNQgj+2jQVNDudOFgSQWs+Es6JhdoTIvf"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"
integrity="sha384-lMHOyuqf3B/T/BgfYxUKprN0bdRf8KhVTE11w76Tvtze86XHVSDYzxqNGDGgIi9I"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"
integrity="sha384-LthJPBJ4RGco78kBY+EmKz5rmISZ5vrtAu3+l2ALQ2mrZHOe6Wyf6knyKjeC4cL6"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"
integrity="sha384-Vu4LjJ210wltbg1I3zl1f5n8qLSDr9GE7ij2JfiMbV64UCFP2RgFtG8W2Gh6Khwe"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"
integrity="sha384-uFEp18/1vv2dYlO64J2lOcnbhirAQZPtruqAZZ7PZYoXenm5c+tIs3AqSMjVMRe8"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"
integrity="sha384-fYBaBAsdPMjWt1AuA+txMoztHnl+zLgObSvwddIabbfUp+36gf/vNOKx88f37zix"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-tabs/dist/docsify-tabs.min.js"
integrity="sha384-QA3IVKzXq6xcKR8yQJHgDbI1FcJiQ137Cuetl1VWzUxJ6BQ7ew0MMq5fg2HbFK1o"
crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-katex@1.4.3/dist/docsify-katex.js"
integrity="sha384-M76M/x5vGyeoej1covQQifl7T945mY+qgzNVrM/urHMCYjP8tnMsx5WCdeLZ74UE"
crossorigin="anonymous"></script>
</body>
</html>
</html>
+75 -90
View File
@@ -1,30 +1,27 @@
# Indicators in QuanTAlib
\* = Returns multiple values
| **Category** | **Status** | **Completion** |
|--------------|:----------:|:--------------:|
| Basic Transforms | 6 of 6 | 100% |
| Averages & Trends | 33 of 33 | 100% |
| Momentum | 17 of 17 | 100% |
| Oscillators | 12 of 29 | 41% |
| Volatility | 15 of 35 | 43% |
| Volume | 19 of 19 | 100% |
| Numerical Analysis | 13 of 20 | 65% |
| Errors | 16 of 16 | 100% |
| **Total** | **131 of 175** | **75%** |
**Implementation Status:**
- Basic Transforms: 6 of 6 complete
- Averages & Trends: 33 of 33 complete
- Momentum: 17 of 17 complete
- Oscillators: 11 of 29 complete
- Volatility: 11 of 35 complete
- Volume: 15 of 19 complete
- Numerical Analysis: 13 of 20 complete
- Errors: 16 of 16 complete
- Total: 122 of 175 indicators implemented (70%)
|**BASIC TRANSFORMS**|**Class Name**|
|---|:--:|
|Technical Indicator Name| Class Name|
|-----------|:----------:|
|**BASIC TRANSFORMS**||
|OC2 - Midpoint price|`.OC2`|
|HL2 - Median Price|`.HL2`|
|HLC3 - Typical Price|`.HLC3`|
|OHL3 - Mean Price|`.OHL3`|
|OHLC4 - Average Price|`.OHLC4`|
|HLCC4 - Weighted Price|`.HLCC4`|
|**AVERAGES & TRENDS**|**Class Name**|
|--|:--:|
|**AVERAGES & TRENDS**||
|AFIRMA - Adaptive FIR Moving Average|`Afirma`|
|ALMA - Arnaud Legoux Moving Average|`Alma`|
|DEMA - Double Exponential Moving Average|`Dema`|
@@ -58,9 +55,7 @@
|VIDYA - Variable Index Dynamic Average|`Vidya`|
|WMA - Weighted Moving Average|`Wma`|
|ZLEMA - Zero-Lag Exponential Moving Average|`Zlema`|
|**MOMENTUM INDICATORS**|**Class Name**|
|--|:--:|
|**MOMENTUM INDICATORS**||
|ADX - Average Directional Movement Index|`Adx`|
|ADXR - Average Directional Movement Index Rating|`Adxr`|
|APO - Absolute Price Oscillator|`Apo`|
@@ -78,79 +73,73 @@
|TRIX - 1-day ROC of TEMA|`Trix`|
|VEL - Jurik Signal Velocity|`Vel`|
|VORTEX* - Vortex Indicator (VI+, VI-)|`Vortex`|
|**OSCILLATORS**|**Class Name**|
|--|:--:|
|**OSCILLATORS**||
|AC - Acceleration Oscillator|`Ac`|
|AO - Awesome Oscillator|`Ao`|
|AROON* - Aroon oscillator (Up, Down)|`Aroon`|
|🚧 BOP - Balance of Power|`Bop`|
|BOP - Balance of Power|`Bop`|
|CCI - Commodity Channel Index|`Cci`|
|CFO - Chande Forcast Oscillator|`Cfo`|
|CMO - Chande Momentum Oscillator|`Cmo`|
|CHOP - Choppiness Index|`Chop`|
|COG - Ehler's Center of Gravity|`Cog`|
|🚧 COPPOCK - Coppock Curve|`Coppock`|
|🚧 CRSI - Connor RSI|`Crsi`|
|🚧 CTI - Ehler's Correlation Trend Indicator|`Cti`|
|🚧 DOSC - Derivative Oscillator|`Dosc`|
|🚧 EFI - Elder Ray's Force Index|`Efi`|
|🚧 FISHER - Fisher Transform|`Fisher`|
|🚧 FOSC - Forecast Oscillator|`Fosc`|
|🚧 GATOR* - Williams Alliator Oscillator (Upper Jaw, Lower Jaw, Teeth)|`Gator`|
|🚧 KDJ* - KDJ Indicator (K, D, J lines)|`Kdj`|
|🚧 KRI - Kairi Relative Index|`Kri`|
|🚧 COPPOCK - Coppock Curve|`Coppock`|
|🚧 CRSI - Connor RSI|`Crsi`|
|🚧 CTI - Ehler's Correlation Trend Indicator|`Cti`|
|🚧 DOSC - Derivative Oscillator|`Dosc`|
|🚧 EFI - Elder Ray's Force Index|`Efi`|
|🚧 FISHER - Fisher Transform|`Fisher`|
|🚧 FOSC - Forecast Oscillator|`Fosc`|
|🚧 GATOR* - Williams Alliator Oscillator (Upper Jaw, Lower Jaw, Teeth)|`Gator`|
|🚧 KDJ* - KDJ Indicator (K, D, J lines)|`Kdj`|
|🚧 KRI - Kairi Relative Index|`Kri`|
|RSI - Relative Strength Index|`Rsi`|
|RSX - Jurik Trend Strength Index|`Rsx`|
|🚧 RVGI* - Relative Vigor Index (RVGI, Signal)|`Rvgi`|
|🚧 SMI - Stochastic Momentum Index|`Smi`|
|🚧 SRSI* - Stochastic RSI (SRSI, Signal)|`Srsi`|
|🚧 STC - Schaff Trend Cycle|`Stc`|
|🚧 STOCH* - Stochastic Oscillator (%K, %D)|`Stoch`|
|🚧 TSI - True Strength Index|`Tsi`|
|🚧 UO - Ultimate Oscillator|`Uo`|
|🚧 WILLR - Larry Williams' %R|`Willr`|
|**VOLATILITY INDICATORS**|**Class Name**|
|--|:--:|
|🚧 ADR - Average Daily Range|`Adr`|
|🚧 AP - Andrew's Pitchfork|`Ap`|
|🚧 RVGI* - Relative Vigor Index (RVGI, Signal)|`Rvgi`|
|🚧 SMI - Stochastic Momentum Index|`Smi`|
|🚧 SRSI* - Stochastic RSI (SRSI, Signal)|`Srsi`|
|🚧 STC - Schaff Trend Cycle|`Stc`|
|🚧 STOCH* - Stochastic Oscillator (%K, %D)|`Stoch`|
|🚧 TSI - True Strength Index|`Tsi`|
|🚧 UO - Ultimate Oscillator|`Uo`|
|🚧 WILLR - Larry Williams' %R|`Willr`|
|**VOLATILITY INDICATORS**||
|ADR - Average Daily Range|`Adr`|
|AP - Andrew's Pitchfork|`Ap`|
|ATR - Average True Range|`Atr`|
|🚧 ATRP - Average True Range Percent|`Atrp`|
|🚧 ATRS - ATR Trailing Stop|`Atrs`|
|🚧 BB* - Bollinger Bands® (Upper, Middle, Lower)|`Bb`|
|🚧 CCV - Close-to-Close Volatility|`Ccv`|
|🚧 CE - Chandelier Exit|`Ce`|
|🚧 CV - Conditional Volatility (ARCH/GARCH)|`Cv`|
|🚧 CVI - Chaikin's Volatility|`Cvi`|
|🚧 DC* - Donchian Channels (Upper, Middle, Lower)|`Dc`|
|🚧 EWMA - Exponential Weighted Moving Average Volatility|`Ewma`|
|🚧 FCB - Fractal Chaos Bands|`Fcb`|
|🚧 GKV - Garman-Klass Volatility|`Gkv`|
|🚧 HLV - High-Low Volatility|`Hlv`|
|ATRP - Average True Range Percent|`Atrp`|
|ATRS - ATR Trailing Stop|`Atrs`|
|🚧 BB* - Bollinger Bands® (Upper, Middle, Lower)|`Bb`|
|🚧 CCV - Close-to-Close Volatility|`Ccv`|
|🚧 CE - Chandelier Exit|`Ce`|
|🚧 CV - Conditional Volatility (ARCH/GARCH)|`Cv`|
|🚧 CVI - Chaikin's Volatility|`Cvi`|
|🚧 DC* - Donchian Channels (Upper, Middle, Lower)|`Dc`|
|🚧 EWMA - Exponential Weighted Moving Average Volatility|`Ewma`|
|🚧 FCB - Fractal Chaos Bands|`Fcb`|
|🚧 GKV - Garman-Klass Volatility|`Gkv`|
|🚧 HLV - High-Low Volatility|`Hlv`|
|HV - Historical Volatility|`Hv`|
|🚧 ICH* - Ichimoku Cloud (Conversion, Base, Leading Span A, Leading Span B, Lagging Span)|`Ich`|
|🚧 ICH* - Ichimoku Cloud (Conversion, Base, Leading Span A, Leading Span B, Lagging Span)|`Ich`|
|JVOLTY - Jurik Volatility|`Jvolty`|
|🚧 KC* - Keltner Channels (Upper, Middle, Lower)|`Kc`|
|🚧 NATR - Normalized Average True Range|`Natr`|
|🚧 PCH - Price Channel Indicator|`Pch`|
|🚧 PSAR* - Parabolic Stop and Reverse (Value, Trend)|`Psar`|
|🚧 PV - Parkinson Volatility|`Pv`|
|🚧 RSV - Rogers-Satchell Volatility|`Rsv`|
|🚧 KC* - Keltner Channels (Upper, Middle, Lower)|`Kc`|
|🚧 NATR - Normalized Average True Range|`Natr`|
|🚧 PCH - Price Channel Indicator|`Pch`|
|🚧 PSAR* - Parabolic Stop and Reverse (Value, Trend)|`Psar`|
|🚧 PV - Parkinson Volatility|`Pv`|
|🚧 RSV - Rogers-Satchell Volatility|`Rsv`|
|RV - Realized Volatility|`Rv`|
|RVI - Relative Volatility Index|`Rvi`|
|🚧 STARC* - Starc Bands (Upper, Middle, Lower)|`Starc`|
|🚧 SV - Stochastic Volatility|`Sv`|
|🚧 STARC* - Starc Bands (Upper, Middle, Lower)|`Starc`|
|🚧 SV - Stochastic Volatility|`Sv`|
|TR - True Range|`Tr`|
|UI - Ulcer Index|`Ui`|
|VC* - Volatility Cone (Mean, Upper Bound, Lower Bound)|`Vc`|
|VOV - Volatility of Volatility|`Vov`|
|VR - Volatility Ratio|`Vr`|
|VS* - Volatility Stop (Long Stop, Short Stop)|`Vs`|
|🚧 YZV - Yang-Zhang Volatility|`Yzv`|
|**VOLUME INDICATORS**|**Class Name**|
|--|:--:|
|🚧 YZV - Yang-Zhang Volatility|`Yzv`|
|**VOLUME INDICATORS**||
|ADL - Chaikin Accumulation Distribution Line|`Adl`|
|ADOSC - Chaikin Accumulation Distribution Oscillator|`Adosc`|
|AOBV - Archer On-Balance Volume|`Aobv`|
@@ -166,36 +155,32 @@
|PVR - Price Volume Rank|`Pvr`|
|PVT - Price Volume Trend|`Pvt`|
|TVI - Trade Volume Index|`Tvi`|
|🚧 VF - Volume Force|`Vf`|
|🚧 VP - Volume Profile|`Vp`|
|🚧 VWAP - Volume Weighted Average Price|`Vwap`|
|🚧 VWMA - Volume Weighted Moving Average|`Vwma`|
|**NUMERICAL ANALYSIS**|**Class Name**|
|--|:--:|
|🚧 BETA* - Beta coefficient (Beta, R-squared)|`Beta`|
|🚧 CORR* - Correlation Coefficient (Correlation, P-value)|`Corr`|
|VF - Volume Force|`Vf`|
|VP - Volume Profile|`Vp`|
|VWAP - Volume Weighted Average Price|`Vwap`|
|VWMA - Volume Weighted Moving Average|`Vwma`|
|**NUMERICAL ANALYSIS**||
|🚧 BETA* - Beta coefficient (Beta, R-squared)|`Beta`|
|🚧 CORR* - Correlation Coefficient (Correlation, P-value)|`Corr`|
|CURVATURE - Rate of Change in Direction or Slope|`Curvature`|
|ENTROPY - Measure of Uncertainty or Disorder|`Entropy`|
|🚧 HUBER - Huber Loss|`Huber`|
|🚧 HURST - Hurst Exponent|`Hurst`|
|🚧 HUBER - Huber Loss|`Huber`|
|🚧 HURST - Hurst Exponent|`Hurst`|
|KURTOSIS - Measure of Tails/Peakedness|`Kurtosis`|
|MAX - Maximum with exponential decay|`Max`|
|MEDIAN - Middle value|`Median`|
|MIN - Minimum with exponential decay|`Min`|
|MODE - Most Frequent Value|`Mode`|
|PERCENTILE - Rank Order|`Percentile`|
|🚧 RSQUARED* - Coefficient of Determination (R-squared, Adjusted R-squared)|`Rsquared`|
|🚧 RSQUARED* - Coefficient of Determination (R-squared, Adjusted R-squared)|`Rsquared`|
|SKEW - Skewness, asymmetry of distribution|`Skew`|
|SLOPE - Rate of Change, Linear Regression|`Slope`|
|STDDEV - Standard Deviation, Measure of Spread|`Stddev`|
|🚧 THEIL* - Theil's U Statistics (U1, U2)|`Theil`|
|🚧 TSF* - Time Series Forecast (Forecast, Confidence Interval)|`Tsf`|
|🚧 THEIL* - Theil's U Statistics (U1, U2)|`Theil`|
|🚧 TSF* - Time Series Forecast (Forecast, Confidence Interval)|`Tsf`|
|VARIANCE - Average of Squared Deviations|`Variance`|
|ZSCORE - Standardized Score|`Zscore`|
|**ERRORS**|**Class Name**|
|--|:--:|
|**ERRORS**||
|HUBER - Huber Loss|`Huber`|
|MAE - Mean Absolute Error|`Mae`|
|MAPD - Mean Absolute Percentage Deviation|`Mapd`|