detrend_A {pdt}R Documentation

detrend_A

Description

Detrends the phase A part of time series y. detrend A is optional and not validated. The mean of the detrended signal will be set to the predicted value based on detrend_A_position: detrend_A_position = "first" : take predicted value for first valid observation detrend_A_position = "center" : take predicted value for center observation detrend_A_position = "last" : take predicted value for last valid observation.

Usage

detrend_A(x, x_values, y, detrend_A_position = "center")

Arguments

x

factor vector to indicate conditions or phases (e.g., "A" and "B")

x_values

numerical vector with distance (time markers) between observations

y

numeric vector with the observed y-values

detrend_A_position

character to indicate the mean

Value

List with the trend and the detrended y-values: x_values_A_trend = vector with distance (time markers) between A-detrended signal, y_A_trend = vector with computed A-trend, y_detrended = vector with computed A-detrended y values.

Examples

pdt::detrend_A(as.factor(c(rep("A",20), rep("B",20))), 1:40,
  c(rnorm(20), rnorm(20)+2), detrend_A_position="center")


[Package pdt version 0.0.2 Index]