plotError: Plot Interpolation Error

View source: R/plotError.R

plotErrorR Documentation

Plot Interpolation Error

Description

Function to generate a plot to visualize the absolute difference between the original time series and the interpolated time series under a specific gap structure. If more than one value of k is selected, the resulting plot represents the average interpolation.

Usage

plotError(
  OriginalData,
  IntData,
  GappyData,
  d,
  p,
  g,
  m,
  output = "plot",
  error_color = "black",
  k = NULL,
  alpha = 0.3
)

Arguments

OriginalData

list; A list containing the original time series

IntData

list; A list containing the interpolated time series

GappyData

list; A list containing the gappy time series

d

character; A single character element describing the dataset of interest

p

numeric; A single numeric element describing the of 'proportion missing' of interest

g

numeric; A single numeric element describing the 'gap length' of interest

m

character; A single character element describing the interpolation method of interest

output

character; "plot" outputs a plot object, "numeric" outputs a numeric vector corresponding to the plot

error_color

character; A character element describing the color (HTML: "#XXXXXX") to use for the error ribbon

k

numeric; Numeric element(s) describing the index positions of individual interpolated time series

alpha

numeric; A numeric value describing the opacity of the error ribbon


castels/interpTools documentation built on June 7, 2024, 4:20 p.m.