Package ‘imputeTS’

July 1, 2019
Version 3.0
Date 2019-07-01
Title Time Series Missing Value Imputation
Description Imputation (replacement) of missing values
in univariate time series.
Offers several imputation functions
and missing data plots.
Available imputation algorithms include:
'Mean', 'LOCF', 'Interpolation',
'Moving Average', 'Seasonal Decomposition',
'Kalman Smoothing on Structural Time Series models',
'Kalman Smoothing on ARIMA models'. Published in Moritz and Bartz-Beielstein (2017)
<doi: 10.32614/RJ-2017-009>.
Author Steffen Moritz [aut, cre, cph]
(<https://orcid.org/0000-0002-0085-1804>),
Sebastian Gatscha [ctb]
Maintainer Steffen Moritz <[email protected]>
LazyData yes
Type Package
ByteCompile TRUE

BugReports https://github.com/SteffenMoritz/imputeTS/issues

URL https://github.com/SteffenMoritz/imputeTS,
https://steffenmoritz.github.io/imputeTS/
Repository CRAN
Depends R (>= 3.0.1)
Imports stats, graphics, grDevices, stinepack, forecast, magrittr,
Rcpp
Suggests testthat, R.rsp, zoo, timeSeries, tis, xts, tibble, tsibble
License GPL-3
VignetteBuilder R.rsp

1
2 imputeTS-package

RoxygenNote 6.0.1
LinkingTo Rcpp
NeedsCompilation yes
Date/Publication 2019-07-01 15:50:11 UTC

R topics documented:
imputeTS-package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
na_interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
na_kalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
na_locf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
na_ma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
na_mean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
na_random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
na_remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
na_replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
na_seadec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
na_seasplit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
plotNA.distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
plotNA.distributionBar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
plotNA.gapsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
plotNA.imputations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
statsNA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
tsAirgap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
tsAirgapComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
tsHeating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
tsHeatingComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
tsNH4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
tsNH4Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Index 29

imputeTS-package imputeTS-package description

Description
The imputeTS package is a collection of algorithms and tools for univariate time series imputation.

Details
The imputeTS package specializes on (univariate) time series imputation. It offers several differ-
ent imputation algorithm implementations. Beyond the imputation algorithms the package also
provides plotting and printing functions of missing data statistics.
The package is easy to use:
na_interpolation 3

- To impute (fill all missing values) in a time series x, run:

> na_interpolation(x)

- To plot missing data statistics for a time series x, run:

> plotNA.distribution(x)

- To print missing data statistics for a time series x, run:

> statsNA(x)

Every other imputation function (starting with na_’algorithm name’) and plotting function (starting
with plotNA.’plot name’) work the same way as in this example.

References
Moritz, Steffen, and Thomas Bartz-Beielstein. "imputeTS: Time Series Missing Value Imputation
in R." R Journal 9.1 (2017). doi: 10.32614/RJ-2017-009.

na_interpolation Missing Value Imputation by Interpolation

Description
Uses either linear, spline or stineman interpolation to replace missing values.

Usage
na_interpolation(x, option = "linear", maxgap = Inf, ...)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
option Algorithm to be used. Accepts the following input:
• "linear" - for linear interpolation using approx
• "spline" - for spline interpolation using spline
• "stine" - for Stineman interpolation using stinterp
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.
... Additional parameters to be passed through to approx or spline interpolation
functions

Details
Missing values get replaced by values of a approx, spline or stinterp interpolation.
4 na_kalman

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

References
Johannesson, Tomas, et al. (2015). "Package stinepack".

See Also
na_kalman, na_locf, na_ma, na_mean, na_random, na_replace, na_seadec, na_seasplit

Examples
# Prerequisite: Create Time series with missing values
x <- ts(c(2, 3, 4, 5, 6, NA, 7, 8))

# Example 1: Perform linear interpolation

na_interpolation(x)

# Example 2: Perform spline interpolation

na_interpolation(x, option = "spline")

# Example 3: Perform stine interpolation

na_interpolation(x, option = "stine")

# Example 4: Same as example 1, just written with pipe operator

x %>% na_interpolation()

# Example 5: Same as example 2, just written with pipe operator

x %>% na_interpolation(option = "spline")

na_kalman Missing Value Imputation by Kalman Smoothing and State Space

Models

Description
Uses Kalman Smoothing on structural time series models (or on the state space representation of an
arima model) for imputation.

Usage
na_kalman(x, model = "StructTS", smooth = TRUE, nit = -1, maxgap = Inf,
...)
na_kalman 5

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
model Model to be used. With this parameter the State Space Model (on which KalmanS-
mooth is performed) can be chosen. Accepts the following input:
• "auto.arima" - For using the state space representation of arima model (us-
ing auto.arima)
• "StructTS" - For using a structural model fitted by maximum likelihood
(using StructTS)
For both auto.arima and StructTS additional parameters for model building can
be given with the . . . parameter
Additionally it is also possible to use a user created state space model (See
code Example 5). This state space model could for example be obtained from
another R package for structural time series modeling. Furthermore providing
the state space representation of a arima model from arima is also possible.
But it is important to note, that user created state space models must meet the
requirements specified under KalmanLike. This means the user supplied state
space model has to be in form of a list with at least components T, Z, h , V, a, P,
Pn. (more details under KalmanLike)
smooth if TRUE - KalmanSmooth is used for estimation, if FALSE - KalmanRun is used.
Since KalmanRun is often considered extrapolation KalmanSmooth is usually
the better choice for imputation.
nit Parameter from Kalman Filtering (see KalmanLike). Usually no need to change
from default.
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.
... Additional parameters to be passed through to the functions that build the State
Space Models (StructTS or auto.arima).

Details
The KalmanSmoother used in this function is KalmanSmooth. It operates either on a Basic Structural Model
obtained by StructTS or the state space representation of a ARMA model obtained by auto.arima.
For an detailed explanation of Kalman Filtering and Space Space Models the following literature is
a good starting point:
• G. Welch, G. Bishop, An Introduction to the Kalman Filter. SIGGRAPH 2001 Course 8, 1995
• Harvey, Andrew C. Forecasting, structural time series models and the Kalman filter. Cam-
bridge university press, 1990
• Grewal, Mohinder S. Kalman filtering. Springer Berlin Heidelberg, 2011

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)
6 na_locf

Author(s)
Steffen Moritz

References
Hyndman RJ and Khandakar Y (2008). "Automatic time series forecasting: the forecast package
for R". Journal of Statistical Software, 26(3).

See Also
na_interpolation, na_locf, na_ma, na_mean, na_random, na_replace, na_seadec, na_seasplit

Examples
# Example 1: Perform imputation with KalmanSmoother and state space representation of arima model
na_kalman(tsAirgap)

# Example 2: Perform imputation with KalmanRun and state space representation of arima model
na_kalman(tsAirgap, smooth = FALSE)

# Example 3: Perform imputation with KalmanSmooth and StructTS model

na_kalman(tsAirgap, model = "StructTS", smooth = TRUE)

# Example 4: Perform imputation with KalmanSmooth and StructTS model with additional parameters
na_kalman(tsAirgap, model = "StructTS", smooth = TRUE, type = "trend")

# Example 5: Perform imputation with KalmanSmooth and user created model

usermodel <- arima(tsAirgap, order = c(1, 0, 1))$model
na_kalman(tsAirgap, model = usermodel)

# Example 6: Same as example 1, just written with pipe operator

tsAirgap %>% na_kalman()

na_locf Missing Value Imputation by Last Observation Carried Forward

Description
Replaces each missing value with the most recent present value prior to it (Last Observation Car-
ried Forward- LOCF). Optionally this can also be done starting from the back of the series (Next
Observation Carried Backward - NOCB).

Usage
na_locf(x, option = "locf", na_remaining = "rev", maxgap = Inf)
na_locf 7

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
option Algorithm to be used. Accepts the following input:
• "locf" - for Last Observation Carried Forward
• "nocb" - for Next Observation Carried Backward
na_remaining Method to be used for remaining NAs.
• "keep" - to return the series with NAs
• "rm" - to remove remaining NAs
• "mean" - to replace remaining NAs by overall mean
• "rev" - to perform nocb / locf from the reverse direction
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.

Details
Replaces each missing value with the most recent present value prior to it (Last Observation Carried
Forward- LOCF). This can also be done from the reverse direction -starting from the back (Next
Observation Carried Backward - NOCB). Both options have the issue, that NAs at the beginning
(or for nocb at the end) of the time series cannot be imputed (since there is no last value to be
carried forward present yet). In this case there are remaining NAs in the imputed time series. Since
this only concerns very few values at the beginning of the series, na_remaining offers some quick
solutions to get a series without NAs back.

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_ma, na_mean, na_random, na_replace, na_seadec, na_seasplit

Examples
# Prerequisite: Create Time series with missing values
x <- ts(c(NA, 3, 4, 5, 6, NA, 7, 8))

# Example 1: Perform LOCF

na_locf(x)

# Example 2: Perform NOCF

8 na_ma

na_locf(x, option = "nocb")

# Example 3: Perform LOCF and remove remaining NAs

na_locf(x, na_remaining = "rm")

# Example 4: Same as example 1, just written with pipe operator

x %>% na_locf()

na_ma Missing Value Imputation by Weighted Moving Average

Description
Missing value replacement by weighted moving average. Uses semi-adaptive window size to ensure
all NAs are replaced.

Usage
na_ma(x, k = 4, weighting = "exponential", maxgap = Inf)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
k integer width of the moving average window. Expands to both sides of the center
element e.g. k=2 means 4 observations (2 left, 2 right) are taken into account. If
all observations in the current window are NA, the window size is automatically
increased until there are at least 2 non-NA values present.
weighting Weighting to be used. Accepts the following input:
• "simple" - Simple Moving Average (SMA)
• "linear" - Linear Weighted Moving Average (LWMA)
• "exponential" - Exponential Weighted Moving Average (EWMA)
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.

Details
In this function missing values get replaced by moving average values. Moving Averages are also
sometimes referred to as "moving mean", "rolling mean", "rolling average" or "running average".
The mean in this implementation taken from an equal number of observations on either side of a
central value. This means for an NA value at position i of a time series, the observations i-1,i+1
and i+1, i+2 (assuming a window size of k=2) are used to calculate the mean.
Since it can in case of long NA gaps also occur, that all values next to the central value are also NA,
the algorithm has a semi-adaptive window size. Whenever there are less than 2 non-NA values in
na_mean 9

the complete window available, the window size is incrementally increased, till at least 2 non-NA
values are there. In all other cases the algorithm sticks to the pre-set window size.
There are options for using Simple Moving Average (SMA), Linear Weighted Moving Average
(LWMA) and Exponential Weighted Moving Average (EWMA).
SMA: all observations in the window are equally weighted for calculating the mean.
LWMA: weights decrease in arithmetical progression. The observations directly next to a central
value i, have weight 1/2, the observations one further away (i-2,i+2) have weight 1/3, the next
(i-3,i+3) have weight 1/4, ...
EWMA: uses weighting factors which decrease exponentially. The observations directly next to a
central value i, have weight 1/2^1, the observations one further away (i-2,i+2) have weight 1/2^2,
the next (i-3,i+3) have weight 1/2^3, ...

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_mean, na_random, na_replace, na_seadec, na_seasplit

Examples
# Example 1: Perform imputation with simple moving average
na_ma(tsAirgap, weighting = "simple")

# Example 2: Perform imputation with exponential weighted moving average

na_ma(tsAirgap)

# Example 3: Perform imputation with exponential weighted moving average, window size 6
na_ma(tsAirgap, k = 6)

# Example 4: Same as example 1, just written with pipe operator

tsAirgap %>% na_ma(weighting = "simple")

na_mean Missing Value Imputation by Mean Value

Description
Missing value replacement by mean values. Different means like median, mean, mode possible.
10 na_mean

Usage
na_mean(x, option = "mean", maxgap = Inf)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
option Algorithm to be used. Accepts the following input:
• "mean" - take the mean for imputation
• "median" - take the median for imputation
• "mode" - take the mode for imputation
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.

Details
Missing values get replaced by overall mean values. The function calculates the mean, median or
mode over all the non-NA values and replaces all NAs with this value. Option ’mode’ replaces NAs
with the most frequent value in the time series. If two or more values occur equally frequent, the
function imputes with the lower value. That’s why ’mode’ is not the best option for decimal values.

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_ma, na_random, na_replace, na_seadec, na_seasplit

Examples
# Prerequisite: Create Time series with missing values
x <- ts(c(2, 3, 4, 5, 6, NA, 7, 8))

# Example 1: Perform imputation with the overall mean

na_mean(x)

# Example 2: Perform imputation with overall median

na_mean(x, option = "median")

# Example 3: Same as example 1, just written with pipe operator

x %>% na_mean()
na_random 11

na_random Missing Value Imputation by Random Sample

Description

Replaces each missing value by drawing a random sample between two given bounds.

Usage

na_random(x, lower_bound = NULL, upper_bound = NULL, maxgap = Inf)

Arguments

x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
lower_bound Lower bound for the random samples. If nothing or NULL is set min(x) will be
used.
upper_bound Upper bound for the random samples. If nothing or NULL is set man(x) will be
used.
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.

Details

Replaces each missing value by drawing a random sample between two given bounds. The default
bounds are the minimum and the maximum value in the non-NAs from the time series. Function
uses runif function to get the random values.

Value

Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)

Steffen Moritz

See Also

na_interpolation, na_kalman, na_locf, na_ma, na_mean, na_replace, na_seadec, na_seasplit

12 na_remove

Examples
# Prerequisite: Create Time series with missing values
x <- ts(c(2, 3, NA, 5, 6, NA, 7, 8))

# Example 1: Replace all NAs by random values that are between min and max of the input time series
na_random(x)

# Example 2: Replace all NAs by random values between 1 and 10

na_random(x, lower_bound = 1, upper_bound = 10)

# Example 3: Same as example 1, just written with pipe operator

x %>% na_random()

na_remove Remove Missing Values

Description
Removes all missing values from a time series.

Usage
na_remove(x)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced

Details
Removes all missing values from a input time series. This shortens the time series by the number
of missing values in the series. Should be handled with care, because this can affect the seasonality
of the time series. Seasonal patterns might be destroyed. Independent from the input, this function
only returns a vector. (the time information of a resulting time series object wouldn’t be correct any
more).

Value
Vector (vector)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_ma, na_mean, na_random, na_replace, na_seadec,
na_seasplit
na_replace 13

Examples
# Example 1: Remove all NAs
# Create Time series with missing values
x <- ts(c(2, 3, NA, 5, 6, NA, 7, 8))

# Example 1: Remove all NAs

na_remove(x)

# Example 2: Remove all NAs in tsAirgap

na_remove(tsAirgap)

# Example 3: Same as example 1, just written with pipe operator

x %>% na_remove()

na_replace Replace Missing Values by a Defined Value

Description
Replaces all missing values with a given value.

Usage
na_replace(x, fill = 0, maxgap = Inf)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
fill Value used to replace the missing values
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_ma, na_mean, na_random, na_seadec, na_seasplit
14 na_seadec

Examples
# Prerequisite: Create Time series with missing values
x <- ts(c(2, 3, NA, 5, 6, NA, 7, 8))

# Example 1: Replace all NAs with 3.5

na_replace(x, fill = 3.5)

# Example 2: Replace all NAs with 0

na_replace(x, fill = 0)

# Example 3: Same as example 1, just written with pipe operator

x %>% na_replace(fill = 3.5)

na_seadec Seasonally Decomposed Missing Value Imputation

Description
Removes the seasonal component from the time series, performs imputation on the deseasonalized
series and afterwards adds the seasonal component again.

Usage
na_seadec(x, algorithm = "interpolation", find_frequency = FALSE,
maxgap = Inf, ...)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
algorithm Algorithm to be used after decomposition. Accepts the following input:
• "interpolation" - Imputation by Interpolation
• "locf" - Imputation by Last Observation Carried Forward
• "mean" - Imputation by Mean Value
• "random" - Imputation by Random Sample
• "kalman" - Imputation by Kalman Smoothing and State Space Models
• "ma" - Imputation by Weighted Moving Average
find_frequency If TRUE the algorithm will try to estimate the frequency of the time-series au-
tomatically.
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.
... Additional parameters for these algorithms that can be passed through. Look at
na_interpolation, na_locf, na_random, na_mean for parameter options.
na_seasplit 15

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_ma, na_mean, na_random, na_replace, na_seasplit

Examples
# Example 1: Perform seasonal imputation using algorithm = "interpolation"
na_seadec(tsAirgap, algorithm = "interpolation")

# Example 2: Perform seasonal imputation using algorithm = "mean"

na_seadec(tsAirgap, algorithm = "mean")

# Example 3: Same as example 1, just written with pipe operator

tsAirgap %>% na_seadec(algorithm = "interpolation")

na_seasplit Seasonally Splitted Missing Value Imputation

Description
Splits the times series into seasons and afterwards performs imputation separately for each of the
resulting time series datasets (each containing the data for one specific season).

Usage
na_seasplit(x, algorithm = "interpolation", find_frequency = FALSE,
maxgap = Inf, ...)

Arguments
x Numeric Vector (vector) or Time Series (ts) object in which missing values
shall be replaced
algorithm Algorithm to be used after splits. Accepts the following input:
• "interpolation" - Imputation by Interpolation
• "locf" - Imputation by Last Observation Carried Forward
• "mean" - Imputation by Mean Value
• "random" - Imputation by Random Sample
• "kalman" - Imputation by Kalman Smoothing and State Space Models
• "ma" - Imputation by Weighted Moving Average
16 plotNA.distribution

find_frequency If TRUE the algorithm will try to estimate the frequency of the time-series au-
tomatically.
maxgap Maximum number of successive NAs to still perform imputation on. Default
setting is to replace all NAs without restrictions. With this option set, consecu-
tive NAs runs, that are longer than ’maxgap’ will be left NA. This option mostly
makes sense if you want to treat long runs of NA afterwards separately.
... Additional parameters for these algorithms that can be passed through. Look at
na_interpolation, na_locf, na_random, na_mean for parameter options.

Value
Vector (vector) or Time Series (ts) object (dependent on given input at parameter x)

Author(s)
Steffen Moritz

See Also
na_interpolation, na_kalman, na_locf, na_ma, na_mean, na_random, na_replace, na_seadec

Examples
# Example 1: Perform seasonal splitted imputation using algorithm = "interpolation"
na_seasplit(tsAirgap, algorithm = "interpolation")

# Example 2: Perform seasonal splitted imputation using algorithm = "mean"

na_seasplit(tsAirgap, algorithm = "mean")

# Example 3: Same as example 1, just written with pipe operator

tsAirgap %>% na_seasplit(algorithm = "interpolation")

plotNA.distribution Visualize Distribution of Missing Values

Description
Visualize the distribution of missing values within a time series.

Usage
plotNA.distribution(x, colPoints = "steelblue",
colBackgroundMV = "indianred2", main = "Distribution of NAs",
xlab = "Time", ylab = "Value", pch = 20, cexPoints = 0.8,
col = "black", ...)
plotNA.distribution 17

Arguments

x Numeric Vector (vector) or Time Series (ts) object containing NAs

colPoints Color of the points for each observation
colBackgroundMV
Color for the background for the NA sequences
main Main label for the plot
xlab Label for x axis of the plot
ylab Label for y axis of plot
pch Plotting ’character’, i.e., symbol to use.
cexPoints character (or symbol) expansion: a numerical vector.
col Color for the lines.
... Additional graphical parameters that can be passed through to plot

Details

This function visualizes the distribution of missing values within a time series. Therefore, the time
series is plotted and whenever a value is NA the background is colored differently. This gives a nice
overview, where in the time series most of the missing values occur.

Author(s)

Steffen Moritz

See Also

plotNA.distributionBar, plotNA.gapsize, plotNA.imputations

Examples
#Example 1: Visualize the missing values in x
x <- ts(c(1:11, 4:9,NA,NA,NA,11:15,7:15,15:6,NA,NA,2:5,3:7))
plotNA.distribution(x)

#Example 2: Visualize the missing values in tsAirgap time series

plotNA.distribution(tsAirgap)

#Example 3: Same as example 1, just written with pipe operator

x <- ts(c(1:11, 4:9,NA,NA,NA,11:15,7:15,15:6,NA,NA,2:5,3:7))
x %>% plotNA.distribution
18 plotNA.distributionBar

plotNA.distributionBar
Visualize Distribution of Missing Values (Barplot)

Description
Visualization of missing values in barplot form. Especially useful for time series with a lot of
observations.

Usage
plotNA.distributionBar(x, breaks = grDevices::nclass.Sturges(x),
breaksize = NULL, percentage = TRUE, legend = TRUE, axis = TRUE,
space = 0, col = c("indianred2", "green2"),
main = "Distribution of NAs", xlab = "Time Lapse", ylab = NULL, ...)

Arguments
x Numeric Vector (vector) or Time Series (ts) object containing NAs
breaks Defines the number of bins to be created. Default number of breaks is calculated
by nclass.Sturges using Sturges’ formula. If the breaksize parameter is set to
a value different to NULL this parameter is ignored.
breaksize Defines how many observations should be in one bin. The required number
of overall bins is afterwards calculated automatically. This parameter if used
overwrites the breaks parameter.
percentage Whether the NA / non-NA ration should be given as percent or absolute numbers
legend If TRUE a legend is shown at the bottom of the plot. A custom legend can be
obtained by setting this parameter to FALSE and using legend function
axis If TRUE a x-axis with labels is added. A custom axis can be obtained by setting
this parameter to FALSE and using axis function
space The amount of space (as a fraction of the average bar width) left before each bar.
col A vector of colors for the bars or bar components.
main Main title for the plot
xlab Label for x axis of the plot
ylab Label for y axis of plot
... Additional graphical parameters that can be passed through to barplot

Details
This function visualizes the distribution of missing values within a time series. In comparison
to the plotNA.distribution function this is not done by plotting each observation of the time
series separately Instead observations for time intervals are represented as bars. For these intervals
information about the amount of missing values are shown. This has the advantage, that also for
large time series a plot which is easy to overview can be created.
plotNA.gapsize 19

Author(s)
Steffen Moritz

See Also
plotNA.distribution, plotNA.gapsize, plotNA.imputations

Examples
#Example 1: Visualize the missing values in tsNH4 time series
plotNA.distributionBar(tsNH4)

#Example 2: Visualize the missing values in tsHeating time series

plotNA.distributionBar(tsHeating, breaks = 20)

#Example 3: Same as example 1, just written with pipe operator

tsNH4 %>% plotNA.distributionBar

plotNA.gapsize Visualize Distribution of NA gap sizes

Description
Visualize Distribution of NA gap sizes (NAs in a row) in a time series

Usage
plotNA.gapsize(x, limit = 10, byTotalNA = FALSE, legend = TRUE,
col = c("indianred", "steelblue"),
xlab = "Ranking of the different gap sizes", ylab = "Number",
main = "Occurrence of gap sizes (NAs in a row)", cex.names = 0.7,
horiz = FALSE, axes = TRUE, beside = TRUE, las = 1, ...)

Arguments
x Numeric Vector (vector) or Time Series (ts) object containing NAs
limit Specifies how many of the top gap sizes are shown in the plot.
byTotalNA For byTotalNA = TRUE the top gap sizes according to their overall weight are
shown. (occurrence * gap size) For byTotalNA = FALSE the top gap sizes are
shown by their number of occurrence. (occurrence)
legend If TRUE a legend is shown at the bottom of the plot. A custom legend can be
obtained by setting this parameter to FALSE and using legend function
col A vector of colors for the bars or bar components.
xlab Label for x axis of the plot
ylab Label for y axis of plot
20 plotNA.imputations

main Main title for the plot

cex.names Expansion factor for axis names (bar labels).
horiz A logical value. If FALSE, the bars are drawn vertically with the first bar to the
left. If TRUE, the bars are drawn horizontally with the first at the bottom.
axes Logical. If TRUE, a vertical (or horizontal, if horiz is true) axis is drawn.
beside A logical value. If FALSE, the columns of height are portrayed as stacked bars,
and if TRUE the columns are portrayed as juxtaposed bars.
las Numeric in 0,1,2,3; the style of axis labels. 0:always parallel to the axis, 1:al-
ways horizontal, 2:always perpendicular to the axis, 3:always vertical.
... Additional graphical parameters that can be passed through to barplot

Details
This plotting function can be used to visualize the length of the NA gaps (NAs in a row) in a time
series. It shows a ranking of which gap sizes occur most often. This ranking can be ordered by total
NAs for this gap size (occurrence * gap length) or by occurrence of the gap size. The outcome will
be somethink like in the time series 2NAs in a row occurred 27times, 4NAs in a row occurred 11
times, 7NAs in a row occurred 5 times, 1NA in a row occurred 3 times, ... .

Author(s)
Steffen Moritz

See Also
plotNA.distribution,plotNA.distributionBar, plotNA.imputations

Examples
#Example 1: Visualize the top gap sizes in tsNH4
plotNA.gapsize(tsNH4)

#Example 2: Visualize the top gap sizes in tsAirgap

plotNA.gapsize(tsAirgap)

#Example 3: Same as example 1, just written with pipe operator

tsNH4 %>% plotNA.gapsize

plotNA.imputations Visualize Imputed Values

Description
Visualize the imputed values in a time series.
plotNA.imputations 21

Usage
plotNA.imputations(x.withNA, x.withImputations, x.withTruth = NULL,
legend = TRUE, main = "Visualization Imputed Values", xlab = "Time",
ylab = "Value", colWithTruth = "green3", colLines = "black",
colWithImputations = "indianred2", colWithNA = "steelblue2",
ylim = c(min(c(x.withImputations, x.withTruth), na.rm = TRUE),
max(c(x.withImputations, x.withTruth), na.rm = TRUE)), pch = 20,
cex = 0.8, ...)

Arguments
x.withNA Numeric Vector or Time Series (ts) object with NAs before imputation
x.withImputations
Numeric Vector or Time Series (ts) object with NAs replaced by imputed values
x.withTruth Numeric Vector or Time Series (ts) object with the real values. (can be set to
NULL if not known)
legend If TRUE a legend is shown at the bottom of the plot. A custom legend can be
obtained by setting this parameter to FALSE and using legend function
main Main title for the plot
xlab Label for x axis of the plot
ylab Label for y axis of plot
colWithTruth Defines the color of the real values (truth) for the NA values.
colLines Defines the color of the lines connecting non-NA observations.
colWithImputations
Defines the color for the imputed values.
colWithNA Defines the color of the non-NA observations.
ylim the y limits of the plot
pch Either an integer specifying a symbol or a single character to be used as the
default in plotting points.
cex A numerical value giving the amount by which plotting text and symbols should
be magnified relative to the default.
... Additional graphical parameters that can be passed through to plot

Details
This plot can be used, to visualize the imputed values for a time series. Therefore, the imputed
values (filled NA gaps) are shown in a different color than the other values. If the real values (truth)
behind the NA gaps are known these are also added in a different color.

Author(s)
Steffen Moritz

See Also
plotNA.distribution,plotNA.distributionBar, plotNA.gapsize
22 statsNA

Examples
#Example 1: Visualize the values that were imputed by na.mean in the time series
impMean.Airgap <- na.mean(tsAirgap)
plotNA.imputations(tsAirgap, impMean.Airgap)

#Example 2: Visualize the values that were imputed by na.locf and the true values in the time series
impLOCF.Airgap <- na.locf(tsAirgap)
plotNA.imputations(tsAirgap, impLOCF.Airgap, tsAirgapComplete)

#Example 3: Same as example 1, just written with pipe operator

tsAirgap %>% na.mean %>% plotNA.imputations(x.withNA = tsAirgap)

statsNA Print Statistics about Missing Values

Description
Print summary stats about the distribution of missing values in a univariate time series.

Usage
statsNA(x, bins = 4, printOnly = TRUE)

Arguments
x Numeric Vector (vector) or Time Series (ts) object containing NAs
bins Split number for bin stats. Number of bins the time series gets divided into.
For each bin information about amount/percentage of missing values is printed.
Default value is 4 - what means stats about the 1st,2nd,3rd,4th quarter of the
time series are shown.
printOnly Choose if the function Prints or Returns. For printOnly = TRUE the function has
no return value and just prints out missing value stats. If printOnly is changed to
FALSE, nothing is printed and the function returns a list. Print gives a little bit
more information, since the returned list does not include "Stats for Bins" and
"overview NA series"

Details
Prints the following information about the missing values in the time series:

• "Length of time series" - Number of observations in the time series (including NAs)
• "Number of Missing Values" - Number of missing values in the time series
• "Percentage of Missing Values" - Percentage of missing values in the time series
• "Stats for Bins" - Number/percentage of missing values for the split into bins
tsAirgap 23

• "Longest NA gap" - Longest series of consecutive missing values (NAs in a row) in the time
series
• "Most frequent gap size" - Most frequent occurring series of missing values in the time series
• "Gap size accounting for most NAs" - The series of consecutive missing values that accounts
for most missing values overall in the time series
• "Overview NA series" - Overview about how often each series of consecutive missing values
occurs. Series occurring 0 times are skipped

It is furthermore, important to note, that you are able to choose whether the function returns a list
or prints the information only. (see description of parameter "printOnly")

Value
A list containing the stats. Beware: Function gives only a return value if printOnly = FALSE.

Author(s)
Steffen Moritz

See Also
plotNA.distribution,plotNA.distributionBar, plotNA.gapsize

Examples
#Example 1: Print stats about the missing data in tsNH4
statsNA(tsNH4)

#Example 2: Return list with stats about the missing data in tsAirgap
statsNA(tsAirgap, printOnly= FALSE)

#Example 3: Same as example 1, just written with pipe operator

tsNH4 %>% statsNA

tsAirgap Time series of monthly airline passengers (with NAs)

Description
Monthly totals of international airline passengers, 1949 to 1960. This time series contains missing
values. In the package included is also the tsAirgapComplete time series providing the true values
for the missing values.

Usage
tsAirgap
24 tsAirgapComplete

Format
Time Series (ts) with 144 rows including 13 NAs.

Details
The dataset originates from Box & Jenkins (see citation) and is a commonly used example in time
series analysis literature.
It characteristics (strong trend, strong seasonal behavior) make it also a great example for time
series imputation. Thus the version with inserted NA gaps was created under the name tsAirgap.
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied.
There are the two time series:

• tsAirgap - The time series with NAs.

• tsAirgapComplete - Time series without NAs.

Source
Box, G. E. P., Jenkins, G. M., Reinsel, G. C. and Ljung, G. M. (2015). Time series analysis:
forecasting and control. Fifth Edition. John Wiley \& Sons.

See Also
tsHeating, tsNH4

tsAirgapComplete Time series of monthly airline passengers (complete)

Description
Monthly totals of international airline passengers, 1949 to 1960. This time series provides the truth
for the missing values of the tsAirgap time series. Thus it is identical to the tsAirgap time series
except that no value is missing.

Usage
tsAirgapComplete

Format
Time Series (ts) with 144 rows.
tsHeating 25

Details

The dataset originates from Box & Jenkins (see citation) and is a commonly used example in time
series analysis literature.
It characteristics (strong trend, strong seasonal behavior) make it also a great example for time
series imputation. Thus the version with inserted NA gaps was created under the name tsAirgap.
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied.
There are the two time series:

• tsAirgap - The time series with NAs.

• tsAirgapComplete - Time series without NAs.

Source

Box, G. E. P., Jenkins, G. M., Reinsel, G. C. and Ljung, G. M. (2015). Time series analysis:
forecasting and control. Fifth Edition. John Wiley \& Sons.

See Also

tsHeating, tsNH4

tsHeating Time series of a heating systems supply temperature (with NAs)

Description

Time series of a heating systems supply temperature. Measured from 18.11.2013 - 05:12:00 to
13.01.2015 - 15:08:00 in 1 minute steps. This time series contains missing values. In the pack-
age included is also the tsHeatingComplete time series providing the true values for the missing
values.

Usage

tsHeating

Format

Time Series (ts) with 606837 rows including 57391 NAs.

26 tsHeatingComplete

Details

The time series originates from the GECCO Industrial Challenge 2015. This Challenge was about
"Recovering missing information in heating system operating data". Goal was to impute miss-
ing values in heating system sensor data as accurate as possible. (http://www.spotseven.de/
gecco-challenge/gecco-challenge-2015/)
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied. The NAs thereby were inserted
according to patterns found in similar time series.
There are the two time series:

• tsHeating - The time series with NAs.

• tsHeatingComplete - Time series without NAs.

Source

http://www.spotseven.de/gecco-challenge/gecco-challenge-2015/

See Also

tsAirgap, tsNH4

tsHeatingComplete Time series of a heating systems supply temperature (complete)

Description

Time series of a heating systems supply temperature. Measured from 18.11.2013 - 05:12:00 to
13.01.2015 - 15:08:00 in 1 minute steps. This time series provides the truth for the missing values
of the tsHeating time series. Thus it is identical to the heating time series except that no value is
missing.

Usage

tsHeatingComplete

Format

Time Series (ts) with 606837 rows.

tsNH4 27

Details
The time series originates from the GECCO Industrial Challenge 2015. This Challenge was about
"Recovering missing information in heating system operating data". Goal was to impute miss-
ing values in heating system sensor data as accurate as possible. (http://www.spotseven.de/
gecco-challenge/gecco-challenge-2015/)
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied. The NAs thereby were inserted
according to patterns found in similar time series.
There are the two time series:
• tsHeating - The time series with NAs.
• tsHeatingComplete - Time series without NAs.

Source
http://www.spotseven.de/gecco-challenge/gecco-challenge-2015/

See Also
tsAirgap, tsNH4

tsNH4 Time series of NH4 concentration in a wastewater system (with NAs)

Description
Time series of NH4 concentration in a wastewater system. Measured from 30.11.2010 - 16:10 to
01.01.2011 - 6:40 in 10 minute steps. This time series contains missing values. In the package
included is also the tsNH4Complete time series providing the true values for the missing values.

Usage
tsNH4

Format
Time Series (ts) with 4552 rows including 883 NAs.

Details
The time series is derived from the dataset of the GECCO Industrial Challenge 2014.
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied. The NAs thereby were inserted
according to patterns found in similar time series.
There are the two time series:
28 tsNH4Complete

• tsNH4 - The time series with NAs.

• tsNH4Complete - Time series without NAs.

Source
http://www.spotseven.de/gecco-challenge/gecco-challenge-2014/

See Also
tsAirgap,tsHeating

tsNH4Complete Time series of NH4 concentration in a wastewater system (complete)

Description
Time series of NH4 concentration in a wastewater system. Measured from 30.11.2010 - 16:10 to
01.01.2011 - 6:40 in 10 minute steps. This time series provides the truth for the missing values of
the tsNH4 time series. Thus it is identical to the heating time series except that no value is missing.

Usage
tsNH4Complete

Format
Time Series (ts) with 4552 rows.

Details
The time series is derived from the dataset of the GECCO Industrial Challenge 2014.
In order to use this series for comparing imputation algorithm results, there are two time series
provided. One series without missing values, which can be used as ground truth. Another series
with NAs, on which the imputation algorithms can be applied. The NAs thereby were inserted
according to patterns found in similar time series.
There are the two time series:
• tsNH4 - The time series with NAs.
• tsNH4Complete - Time series without NAs.

Source
http://www.spotseven.de/gecco-challenge/gecco-challenge-2014/

See Also
tsAirgap,tsHeating
Index

∗Topic datasets spline, 3

tsAirgap, 23 statsNA, 22
tsAirgapComplete, 24 stinterp, 3
tsHeating, 25 StructTS, 5
tsHeatingComplete, 26
tsNH4, 27 ts, 3–5, 7–19, 21, 22, 24–28
tsNH4Complete, 28 tsAirgap, 23, 24, 26–28
tsAirgapComplete, 23, 24
approx, 3 tsHeating, 24, 25, 25, 26, 28
arima, 5 tsHeatingComplete, 25, 26
auto.arima, 5 tsNH4, 24–27, 27, 28
axis, 18 tsNH4Complete, 27, 28

imputeTS-package, 2 vector, 3–5, 7–19, 22

KalmanLike, 5
KalmanRun, 5
KalmanSmooth, 5

legend, 18, 19, 21

list, 23

na_interpolation, 3, 6, 7, 9–16
na_kalman, 4, 4, 7, 9–13, 15, 16
na_locf, 4, 6, 6, 9–16
na_ma, 4, 6, 7, 8, 10–13, 15, 16
na_mean, 4, 6, 7, 9, 9, 11–16
na_random, 4, 6, 7, 9, 10, 11, 12–16
na_remove, 12
na_replace, 4, 6, 7, 9–12, 13, 15, 16
na_seadec, 4, 6, 7, 9–13, 14, 16
na_seasplit, 4, 6, 7, 9–13, 15, 15
nclass.Sturges, 18

plotNA.distribution, 16, 18–21, 23

plotNA.distributionBar, 17, 18, 20, 21, 23
plotNA.gapsize, 17, 19, 19, 21, 23
plotNA.imputations, 17, 19, 20, 20

runif, 11

29