get_deff: Function to calculate design effect ('DEFF') given...

Description Usage Arguments Value Examples

View source: R/get_deff.R

Description

Function to calculate design effect (DEFF) given intracluster correlation coefficient (ICC) and cluster size.

Usage

1
get_deff(x, cluster, size)

Arguments

x

variable to calculate ICC from

cluster

variable identifying the clusters or groupings of the variable

size

number of samples within a cluster

Value

A numeric value for design effect (DEFF)

Examples

1
2
3
  x <- sample(1:2, size = 25, replace = TRUE)
  cluster <- c(rep(1, 5), rep(2, 5), rep(3, 5), rep(4, 5), rep(5, 5))
  get_deff(x = x, cluster = cluster, size = 10)

validmeasures/sampsizer documentation built on Sept. 8, 2019, 11:19 p.m.