dataAlignment: Alignment of the data

Description Usage Arguments Value Examples

View source: R/DataAlignment.R

Description

Align the monitoring sample X and the reference sample Y.

Usage

1
2
3
4
5
6
7
dataAlignment(
  X,
  Y,
  alignment = "unadjusted",
  constant = NULL,
  absolute = FALSE
)

Arguments

X

vector. Monitoring sample.

Y

vector. Reference sample.

alignment

character string. Aligment of the data X and Y. Select from

  • "unadjusted": nothing is sustracte from X and Y (default).

  • "overallmean": overall mean is sustracted from X and Y.

  • "overallmedian": overall median is sustracted from X and Y.

  • "samplemean": mean from corresponding group (X and Y) is sustracted from its corresponing vector.

  • "samplemedian": median from corresponding group (X and Y) is sustracted from its corresponing vector.

  • "referencemean": mean from Y is subtracted from X and Y.

  • "referencemedian": median from Y is subtracted from X and Y.

  • "constantvalue": a constant value is subtracted from X and Y.

constant

scalar. Only used when the alignment is selected "constantvalue". Default NULL.

absolute

logical. If TRUE, the absolute aligned values are obtained. (Default FALSE)

Value

Multiple output. Select by output$

Examples

1
2
3
X = c(30, 45, 50)
Y = c(20, 22, 25, 30, 70)
dataAlignment(X,Y)

SNSchart documentation built on April 7, 2021, 9:07 a.m.