EFAtools (version 1.1.0)

print.efa_power: Print and format an efa_power object

Description

print() turns an efa_power() result into a short report, and format() builds the same report as a character vector (print() is cat(format(x), sep = "\n")).

Usage

# S3 method for efa_power
print(x, digits = 3, ...)
# S3 method for efa_power
format(x, digits = 3, ...)

Value

print() returns its argument x invisibly. format() returns a character vector with the report lines.

Arguments

x

An object of class efa_power (output from efa_power()).

digits

Integer. The number of decimal places the reported values are rounded to. Default is 3.

...

Not used; for consistency with the generic.

Details

For an RMSEA-mode object, the report has a header naming the test, the null and alternative hypotheses with the significance level and degrees of freedom, the headline result (the power at the sample size, or the required sample size for the target power), and the critical value and noncentrality parameters.

For a simulation-mode object, the report instead has the population and design, the retention hit-rate per criterion, the structure-recovery rate, and the convergence and Heywood-case rate.

The lines follow the active console theme, so they print as plain text when colours are disabled -- for example when captured into a file, or stripped with cli::ansi_strip().

See Also

Other power analysis: efa_power(), plot.efa_power()

Examples

pw <- efa_power(df = 100, N = 200)
pw

# format() returns the same lines as a character vector:
writeLines(format(pw))