get_VPC: Calculate the variance partitioning coefficient

View source: R/VPC.r

get_VPCR Documentation

Calculate the variance partitioning coefficient

Description

Calculate the variance partitioning coefficient

Usage

get_VPC(object)

## S3 method for class 'plcp'
get_VPC(object)

Arguments

object

An object created by study_parameters

Details

For partially nested studies, the VPC is calculated for the treatment group.

Value

a data.frame with class plcp_VPC containing the percentage of variance per level and time point. The column between_clusters is also the intraclass correlation for level three, i.e. the correlation between two subjects belonging to the same cluster at a specific time point. With random slopes in the model the variances per time point will be a quadratic function of time. tot_var is the percentage increase or decrease in total variance relative to baseline variance.

The plot method returns a ggplot2::ggplot object.

References

Goldstein, H., Browne, W., & Rasbash, J. (2002). Partitioning variation in multilevel models. Understanding Statistics: Statistical Issues in Psychology, Education, and the Social Sciences, 1(4), 223-231.

See Also

plot.plcp_VPC

Examples

paras <- study_parameters(n1 = 11,
                          n2 = 10,
                          n3 = 3,
                          T_end = 10,
                          icc_pre_subject = 0.5,
                          icc_pre_cluster = 0,
                          icc_slope = 0.05,
                          var_ratio = 0.03)

res <- get_VPC(paras)
res

# Plot
plot(res)

rpsychologist/powerlmm documentation built on May 11, 2023, 12:24 a.m.