summary.powRICLPM: Summarize Results from 'powRICLPM' Object

View source: R/summary.R

summary.powRICLPMR Documentation

Summarize Results from powRICLPM Object

Description

S3 method for class powRICLPM. summary.powRICLPM summarizes the setup and results of the powRICLPM analysis. Depending on the arguments that are set, summary.powRICLPM provides a different summary (see "Details").

Usage

## S3 method for class 'powRICLPM'
summary(
  object,
  ...,
  parameter = NULL,
  sample_size = NULL,
  time_points = NULL,
  ICC = NULL,
  reliability = NULL
)

Arguments

object

A powRICLPM object.

...

(don't use)

parameter

Character string of length 1 denoting the parameter to visualize the results for.

sample_size

(optional) An integer, denoting the sample size of the experimental condition of interest.

time_points

(optional) An integer, denoting the number of time points of the experimental condition of interest.

ICC

(optional) A double, denoting the proportion of variance at the between-unit level of the experimental condition of interest.

reliability

(optional) An integer, denoting the reliability of the indicators of the experimental condition of interest.

Details

summary.powRICLPM provides a different summary of the powRICLPM object, depending on the additional arguments that are set:

  • When sample_size = ..., time_points = ..., ICC = ..., and reliability are set: Estimation information and results for all parameters across experimental conditions.

  • When parameter = "..." is set: Estimation information and results for a specific parameter across all experimental conditions.

  • No additional arguments: Characteristics of the different experimental conditions are summarized, as well as session info (information that applies to all conditions, such the number of replications, etc.).

Interpretation Output

Depending on the arguments that you set, summary() prints a table with different analysis outcomes in the columns and where each row refers to a different experimental condition. The following information is available:

  • Sample size, Time points, ICC, Reliability: The experimental condition that the row refers to.

  • Population: The true value of the parameter.

  • Avg: The average (across replications) parameter estimate.

  • Bias: The difference between the population value and the average parameter estimate.

  • Min: The lowest (across replications) parameter estimate.

  • SD: The standard deviation of the parameter estimate over replications.

  • SEAvg: The average (across replications) standard error of the parameter estimate.

  • MSE: The parameter mean square error, combining a parameter's bias and efficiency.

  • Accuracy: The average (across replications) width of the confidence interval.

  • Cover: The coverage rate, representing the proportion of times (across replications) the true parameter estimate fell in the confidence interval.

  • Power: The proportion of times (across replications) the confidence interval did not contain zero.

  • Error: The number of replications that failed to run (i.e., lavaan() produced an error).

  • Not converged: The number of replications that did not converge to a solution.

  • Inadmissible: The number of replications that converged to an inadmissible solution (e.g., a variance estimated to be lower than zero).

Value

No return value, called for side effects.

Examples


# Get setup of powRICLPM analysis and convergence issues
summary(out_preliminary)

# Performance measures for "wB2~wA1" parameter across experimental conditions
summary(out_preliminary, parameter = "wB2~wA1")

# Performance measures for all parameters, for specific experimental condition
summary(out_preliminary, sample_size = 700, time_points = 4, ICC = .3, reliability = 1)


powRICLPM documentation built on Oct. 26, 2024, 5:14 p.m.