truncate_phase: Truncate single-case data

View source: R/deprec-truncate_phase.R

truncate_phaseR Documentation

Truncate single-case data

Description

#' This function is superseded by the more versatile transform.scdf function. This function truncates data points at the beginning and / or end of each phase in each case.

Usage

truncate_phase(
  data,
  dvar,
  pvar,
  truncate = list(A = c(0, 0), B = c(0, 0)),
  na = TRUE
)

Arguments

data

A single-case data frame. See scdf() to learn about this format.

dvar

Character string with the name of the dependent variable. Defaults to the attributes in the scdf file.

pvar

Character string with the name of the phase variable. Defaults to the attributes in the scdf file.

truncate

A list with a vector of two (beginning and end) values for each phase defining the number of data points to be deleted. For lists of single-case data frames, the truncation is adapted to the length of each phase for each single case.

na

If FALSE, the truncated measurement times are deleted. If TRUE, NAs are set for the dependent variable.

Value

A truncated data frame (for each single-case).

Author(s)

Juergen Wilbert

See Also

Other data manipulation functions: add_l2(), as.data.frame.scdf(), as_scdf(), fill_missing(), moving_median(), outlier(), ranks(), rescale(), scdf(), select_cases(), set_vars(), shift(), smooth_cases(), standardize()

Examples


## Truncate the first two data points of both phases and compare the two 
## data sets
study <- c(
  "Original" = byHeart2011[1],
  "Selected" = truncate_phase(
    byHeart2011[1], truncate = list(A = c(2, 0), B = c(2, 0))
  )
)
plot(study)

jazznbass/scan_develop documentation built on Sept. 9, 2024, 6:23 a.m.