simple_moving_average() is a generic S3 function that preserves
the input class: data.frame in, data.frame out; matrix in,
matrix out.
simple_moving_average() also accepts a double vector, in which case the indicator is calculated directly without column selection. When the result has a single column it is simplified to a double vector; otherwise the full n by k matrix is returned.
Handling of NA values
Every indicator always emits leading NAs for the initial
lookback period - positions where there is not yet enough data to
produce a result. This is separate from how NAs already present
in the input are handled, which is controlled by the na.bridge
argument:
na.bridge = FALSE(default)The input is passed to the underlying TA-Lib C routine as-is. Because most indicators smooth across time (EMA, RSI, MACD, Bollinger Bands, ...), a single
NAin the input typically propagates forward and poisons every subsequent value - it is common for one missing observation to produce an output that is entirelyNAfrom that position onward. This mode is the right choice when you want to see the missing data in the output rather than silently compute around it.na.bridge = TRUENArows are stripped from the input before the C routine runs; the indicator is computed on the resulting dense series; results are then re-expanded to the original length withNAinserted at every position the input hadNA. Output length always matches input length, so the result can be joined back to the sourcedata.frameby row.Consequence to understand before enabling: bridging causes the indicator to treat non-consecutive observations as consecutive. A 14-period RSI with
na.bridge = TRUEover a series containing a month-long gap will compute using 14 observations that span several real-world months as if they were 14 adjacent trading days. For sparse missing values (e.g. a single missing tick) this is harmless; for clustered gaps (e.g. a delisted period, a weekend encoded asNA) the output is correctly aligned by position but economically meaningless across the gap. Inspect gap structure withwhich(is.na(x))before enabling on low-quality time series.
Arguments
- x
An OHLC-V series coercible to data.frame. Alternatively,
xmay also be supplied as a double vector.- cols
(formula). An optional
1-variable formula selecting columns fromxvia model.frame. Defaults to~close.- n
(integer). Lookback period (window size). A positive integer of length 1.
- na.bridge
(logical). A logical of length 1. FALSE by default. When FALSE, input
NAs propagate through the TA-Lib C routine (most indicators will fill the remaining output withNA). When TRUE, inputNArows are stripped before computation and re-inserted at the original positions in the output, causing the indicator to treat non-consecutive non-NAobservations as if they were adjacent — see the Handling ofNAvalues section above for the consequences.- ...
Additional parameters passed into model.frame.
Details
When passed without 'x', simple_moving_average functions as an 'Moving Average'-specification which is used in, for example, stochastic when constructing the smoothing lines.
When called without 'x' it will return a named list which is used for the indicators that supports various Moving Average specifications.
See also
Other Overlap Study:
acceleration_bands(),
bollinger_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(),
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::simple_moving_average(BTC)
## display the results
utils::tail(output)
#> SMA
#> 2024-12-26 01:00:00 98741.48
#> 2024-12-27 01:00:00 98681.76
#> 2024-12-28 01:00:00 98663.68
#> 2024-12-29 01:00:00 98532.28
#> 2024-12-30 01:00:00 98404.20
#> 2024-12-31 01:00:00 98275.22
## 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::simple_moving_average
)
}
