clusterSize distribution missing from help documentation #255

Description

The help page "Distributions for Data Definitions" is missing the clusterSize distribution, even though clusterSize has been supported in simstudy for some time and is documented in the distributions vignette.

Currently, the help file lists the following distributions:

• beta
• binary
• binomial
• categorical
• custom
• exponential
• gamma
• mixture
• negBinomial
• nonrandom
• normal
• noZeroPoisson
• poisson
• trtAssign
• uniform
• uniformInt

However, clusterSize is omitted from both:

1. The summary table of available distributions.
2. The detailed distribution descriptions.

Expected behavior

The help page should include clusterSize alongside the other supported distributions.

The vignette already contains a description that could be adapted:

The clusterSize distribution allocates a total sample size N (specified in the formula argument) across the k rows of the data.table such that the sum of the rows equals N. If the dispersion argument is set to 0, the allocation to each row is N/k, with some rows getting an increment of 1 to ensure that the sum is N. It is possible to relax the assumption of balanced cluster sizes by setting dispersion > 0. As the dispersion increases, the variability of cluster sizes across clusters increases.

Suggested fix

Update the Rd documentation (and any associated roxygen source) to:

• Add clusterSize to the distribution summary table.
• Add a dedicated section describing the distribution, its use of formula and variance (dispersion), and any supported link functions.

Notes

The distributions vignette already documents clusterSize, so the issue appears to be an inconsistency between the vignette and the help page rather than a missing feature.