- formula
A formula object with the clustering solution on the left side and the covariates of interest on the ride side.
- data
The dataset (data frame) with column names corresponding to the information in formula. The number of individuals (row number) should match the dimension of diss.
- diss
The numerical dissimilarity matrix used for clustering. Only a pre-computed matrix (i.e., where pairwise dissimilarities do not depend on the resample) is currently supported.
- robust
Logical. TRUE (the default) indicates that RARCAT should be performed. FALSE implies a much faster function run but only output the original analysis, which is a standard regression analysis for all combinations of reference clusters and covariates.
- R
The integer number of bootstrap. Set to 500 by default to attain a satisfactory precision around the estimates as the procedure involves multiple steps.
- kmedoid
The clustering algorithm as a character string. Currently only "pam" (calling the function wcKMedRange) and "hierarchical" (calling the function fastcluster::hclust) are supported. By default "pam".
- hclust.method
A character string with the method argument of hclust, "ward.D" by default.
- fixed
Logical. TRUE implies that the number of clusters is the same in every bootstrap. FALSE (default) implies that an optimal number of clusters is evaluated each time.
- ncluster
Integer. Either the number of clusters in every bootstrap if fixed is TRUE or the maximum number of clusters (starting from 2) to be evaluated in each bootstrap if fixed is FALSE.
- cqi
A character string with the cluster quality index to be evaluated for each new partition. Any column of as.clustrange is supported, "CH" (the Calinski-Harabasz index) by default. Also works with algo= "pam".
- parallel
Logical. Whether to initialize the parallel processing of the future package using the default multisession strategy. If FALSE (default), then the current plan is used. If TRUE, multisession plan is initialized using default values.
- progressbar
Logical. Whether to initialize a progressbar using the future package. If FALSE (default), then the current progress bar handlers is used . If TRUE, a new global progress bar handlers is initialized.
- fisher.transform
Logical. TRUE means that a Fisher transformation is applied in the multilevel model estimation step. This can be recommended in case of extreme associations (close to the -1 or 1 boundaries). FALSE by default.
- lmerCtrl
Control parameter for lme4 (see lmerControl
- x
rarcat object to be printed or plotted.
- object
rarcat object for summary (diagnostic tools).
- conf.level
Confidence level for the confidence intervals. 0.95 by default.
- digits
Number of significant digits to print (3 by default).
- single.row
Logical. Whether to show confidence interval on the same or separate line (Default=FALSE).
- what
Character. Information to plot. With "AME" (default), the boostrapped AME are shown. Set to "ranef" to view the distribution of observation-level random effect (usefull to identify potentially influential unstable observation).
- covar
Character. The covariate of interest.
- pooled.ame
Logical. Whether to add a vertical line and confidence interval for the pooled AME.
- naive.ame
Logical. Whether to add a vertical line and confidence interval for the naive AME.
- with.legend
Logical. If FALSE, the legend is not plotted.
- legend.prop
Real in range [0,1]. Proportion of the graphic area devoted to the legend plot with.legend=TRUE. Default value is set according to the place (bottom or right of the graphic area) where the legend is plotted.
- rows
Integers. Number of rows of the plot panel.
- cols
Integers. Number of columns of the plot panel.
- main
Character string. Title of the graphic.
- xlab
x axis label.
- xlim
Numerics. Limits of the x-axis.
- ...
Additionnal parameters passed to/from methods.