Explore.WS.Corr {CorrMixed}R Documentation

Explore within-subject correlations (reliabilities)

Description

This function allows for exploring the within-subject (test-retest) correlation (R) structure in the data, taking relevant covariates into account. Estimated correlations as a function of time lag (= absolute difference between measurement moments t_1 and t_2) are provided as well as their confidence intervals (based on a non-parametric bootstrap).

Usage

Explore.WS.Corr(OLS.Model=" ", Dataset, Id, Time, 
Alpha=0.05, Smoother.Span=.2, Number.Bootstrap=100, 
Seed=1)

Arguments

OLS.Model

OLS.Model is a formula passed to lm (to obtain the OLS residuals, i.e., to take covariates into account in the computation of R). OLS.Model should thus be a formula that specifies the outcome of interest followed by a ~ sign and the covariates to be taken into account, e.g.

OLS.Model="Outcome~1+as.factor(Time) + as.factor(Treatment)".

Dataset

A data.frame that should consist of multiple lines per subject ('long' format).

Id

The subject indicator.

Time

The time indicator. Should be coded as 1, 2, etc.

Alpha

The \alpha-level to be used in the non-parametric bootstrap-based Confidence Interval for R. Default Alpha=0.05

Smoother.Span

A smoothing (loess) technique is used to estimate R as a function of time lag. The smoother span gives the proportion of points in the plot which influence the smooth at each value. Larger values give more smoothness. For details, see https://stat.ethz.ch/R-manual/R-patched/library/stats/html/lowess.html. Defauls Smoother.Span=.2.

Number.Bootstrap

The number of non-parametric bootstrap samples to be used to estimate the Confidence Interval for R. Default Number.Bootstrap=100

Seed

The seed to be used in the bootstrap. Default Seed=1.

Value

Est.Corr

The estimated correlations R as a function of time lag. A smoothing (loess) technique is used to estimate R as a function of time lag (based on the output in All.Corrs).

All.Corrs

A matrix that contains the estimated correlations R for all individual time lags.

Bootstrapped.Corrs

A matrix that contains the estimated correlations R as a function of time lag in the bootstrapped samples.

Alpha

The \alpha level used in the estimation of the confidence interval.

CI.Upper

The upper bounds of the confidence intervals.

CI.Lower

The lower bounds of the confidence intervals.

Author(s)

Wim Van der Elst, Geert Molenberghs, Ralf-Dieter Hilgers, & Nicole Heussen

References

Van der Elst, W., Molenberghs, G., Hilgers, R., & Heussen, N. (2015). Estimating the reliability of repeatedly measured endpoints based on linear mixed-effects models. A tutorial. Submitted.

See Also

plot.Explore.WS.Corr

Examples

# Open data
data(Example.Data)

# Explore correlation structure
Expl_Corr <- Explore.WS.Corr(OLS.Model="Outcome~as.factor(Time)+ 
  as.factor(Cycle) + as.factor(Condition)", Dataset=Example.Data, 
  Id="Id", Time="Time", Alpha=.05, Number.Bootstrap=50, Seed=123)

# explore results
summary(Expl_Corr)

# plot with correlations for all time lags, and 
# add smoothed (loess) correlation function 
plot(Expl_Corr, Indiv.Corrs=TRUE)
# plot bootstrapped smoothed (loess) correlation function 
plot(Expl_Corr)

[Package CorrMixed version 1.1 Index]