tmatta / lsasim

Simulate large scale assessment data
6 stars 5 forks source link

Inconsistent documentation on cluster_gen_* subfunctions #52

Open wleoncio opened 1 week ago

wleoncio commented 1 week ago

They should use @inheritParams cluster_gen, but watch out for the fact that the subfunctions contain details missing from cluster_gen()! For example, on cluster_gen_separate():

#' @param sampling_method can be "SRS" for Simple Random Sampling or "PPS" for Probabilities Proportional to Size, "mixed" to use SRS for students and PPS otherwise or a vector with the sampling method for each level

On cluster_gen(), there's no explanation of how "mixed" works, even though it is the default. ☠️