The bollinger_bands() is a generic S3 function that builds upon 'type-safe'-esque workflows limited to classes in in base R, and the package-wide
dependencies. Ie. class in, class out. Each method is a soft wrapper of model.frame and therefore the OHLC-V series must be coercible to a data.frame.
bollinger_bands() also accepts a double vector in which case the indicator is calculated 'as-is' without passing through model.frame. bollinger_bands() returns an n by k matrix computed in C by default. When k = 1, the result is simplified to a double vector; for k > 1, the full n by k matrix is returned.
Usage
bollinger_bands(x, cols, ma = SMA(n = 10), std_up = 2, std_down = 2, ...)Arguments
- x
An OHLC-V series that is coercible to data.frame. Alternatively,
xmay also be supplied as a double vector.- cols
(formula). An optional
1variable formula passed into model.frame. Internally uses~closeby default.- ma
(list). The type of Moving Average (MA) used for the
MiddleBand. SMA by default.- std_up
(double). Deviation multiplier for upper band
- std_down
(double). Deviation multiplier for lower band
- ...
Additional parameters passed into model.frame
See also
Other Overlap Study:
acceleration_bands(),
double_exponential_moving_average(),
exponential_moving_average(),
extended_parabolic_stop_and_reverse(),
kaufman_adaptive_moving_average(),
mesa_adaptive_moving_average(),
parabolic_stop_and_reverse(),
simple_moving_average(),
t3_exponential_moving_average(),
trendline(),
triangular_moving_average(),
triple_exponential_moving_average(),
weighted_moving_average()
Examples
## load Bitcoin (BTC)
## series
data(BTC, package = "talib")
## calculate the indicator
## for Bitcoin (BTC)
output <- talib::bollinger_bands(BTC)
## display the results
utils::tail(output)
#> UpperBand MiddleBand LowerBand
#> 2024-12-26 01:00:00 104478.35 98217.88 91957.42
#> 2024-12-27 01:00:00 100877.73 97020.16 93162.59
#> 2024-12-28 01:00:00 99886.22 96516.01 93145.81
#> 2024-12-29 01:00:00 99871.12 96134.41 92397.71
#> 2024-12-30 01:00:00 99713.92 95620.42 91526.92
#> 2024-12-31 01:00:00 99373.89 95236.42 91098.95
## visualize the indicator
## with talib::chart()
##
## see ?talib::chart or ?talib::indicator
## for more details
{
## chart OHLC-V
## series with talib::chart()
talib::chart(BTC)
## chart indicator
## with default values
talib::indicator(
talib::bollinger_bands
)
}
