# Utility Functions for nScree Class Objects Utility functions for `structureSim` class objects. Note that with the `plot.structureSim` a dotted black vertical line shows the median number of factors retained by all the different indices. ```r ## S3 method for class 'structureSim' summary(object, index = c(1:15), eigenSelect = NULL, ...) ## S3 method for class 'structureSim' print(x, index = NULL, ...) ## S3 method for class 'structureSim' boxplot( x, nFactors = NULL, eigenSelect = NULL, vLine = "green", xlab = "Factors", ylab = "Eigenvalues", main = "Eigen Box Plot", ... ) ## S3 method for class 'structureSim' plot(x, nFactors = NULL, index = NULL, main = "Index Acuracy Plot", ...) is.structureSim(object) ``` ## Arguments - `object`: structureSim: an object of the class `structureSim` - `index`: numeric: vector of the index of the selected indices - `eigenSelect`: numeric: vector of the index of the selected eigenvalues - `...`: variable: additionnal parameters to give to the `boxplot`, `plot`, `print` and `summary functions.` - `x`: structureSim: an object of the class `structureSim` - `nFactors`: numeric: if known, number of factors - `vLine`: character: color of the vertical indicator line of the initial number of factors in the eigen boxplot - `xlab`: character: x axis label - `ylab`: character: y axis label - `main`: character: main title ## Returns Generic functions for the `structureSim` class: - **boxplot.structureSim**: graphic: plots an eigen boxplot - **is.structureSim**: logical: is the object of the class `structureSim`? - **plot.structureSim**: graphic: plots an index acuracy plot - **print.structureSim**: numeric: data.frame of statistics about the number of components/factors to retain according to different indices following a `structureSim` simulation - **summary.structureSim**: list: two data.frame, the first with the details of the simulated eigenvalues, the second with the details of the simulated indices ## Examples ```r ## Not run: if(interactive()){ ## INITIALISATION library(xtable) library(nFactors) nFactors <- 3 unique <- 0.2 loadings <- 0.5 nsubjects <- 180 repsim <- 10 var <- 36 pmjc <- 12 reppar <- 10 zwick <- generateStructure(var=var, mjc=nFactors, pmjc=pmjc, loadings=loadings, unique=unique) ## SIMULATIONS mzwick <- structureSim(fload=as.matrix(zwick), reppar=reppar, repsim=repsim, details=TRUE, N=nsubjects, quantile=0.5) ## TEST OF structureSim METHODS is(mzwick) summary(mzwick, index=1:5, eigenSelect=1:10, digits=3) print(mzwick, index=1:10) plot(x=mzwick, index=c(1:10), cex.axis=0.7, col="red") graphics::boxplot(x=mzwick, nFactors=3, vLine="blue", col="red") } ## End(Not run) ``` ## References Raiche, G., Walls, T. A., Magis, D., Riopel, M. and Blais, J.-G. (2013). Non-graphical solutions for Cattell's scree test. Methodology, 9(1), 23-29. ## See Also `nFactors-package` ## Author(s) Gilles Raiche Centre sur les Applications des Modeles de Reponses aux Items (CAMRI) Universite du Quebec a Montreal raiche.gilles@uqam.ca

structureSimObjectMethods function