diff --git a/R/simstudy-package.R b/R/simstudy-package.R index 321a1b03..2259e7db 100644 --- a/R/simstudy-package.R +++ b/R/simstudy-package.R @@ -38,6 +38,7 @@ NULL #' | binary | probability for 1 | String or Number | NA | identity, log, or logit | #' | binomial | probability of success | String or Number | number of trials | identity, log, or logit | #' | categorical | probabilities | `p_1;p_2;..;p_n` | category labels: `a;b;c` , `50;130;20`| identity or logit | +#' | clusterSize | total N | String or Number | dispersion | identity | #' | custom | name of function | String | arguments | identity | #' | exponential | mean (lambda) | String or Number | NA | identity or log | #' | gamma | mean | String or Number | dispersion value | identity or log | @@ -63,7 +64,7 @@ NULL #' def #' genData(5, def) #' @name distributions -#' @aliases normal poisson noZeroPoisson binary binomial uniform categorical gamma beta negBinomial nonrandom exponential mixture +#' @aliases normal poisson noZeroPoisson binary binomial uniform categorical clusterSize gamma beta negBinomial nonrandom exponential mixture #' @md NULL diff --git a/man/distributions.Rd b/man/distributions.Rd index a3d8fffb..928d0d74 100644 --- a/man/distributions.Rd +++ b/man/distributions.Rd @@ -9,6 +9,7 @@ \alias{binomial} \alias{uniform} \alias{categorical} +\alias{clusterSize} \alias{gamma} \alias{beta} \alias{negBinomial} @@ -41,6 +42,7 @@ distribution can be found in this table:\tabular{lllll}{ binary \tab probability for 1 \tab String or Number \tab NA \tab identity, log, or logit \cr binomial \tab probability of success \tab String or Number \tab number of trials \tab identity, log, or logit \cr categorical \tab probabilities \tab \verb{p_1;p_2;..;p_n} \tab category labels: \verb{a;b;c} , \verb{50;130;20} \tab identity or logit \cr + clusterSize \tab total N \tab String or Number \tab dispersion \tab identity \cr custom \tab name of function \tab String \tab arguments \tab identity \cr exponential \tab mean (lambda) \tab String or Number \tab NA \tab identity or log \cr gamma \tab mean \tab String or Number \tab dispersion value \tab identity or log \cr