powRICLPM (version 0.2.0)

give: Extract Information From powRICLPM Object

Description

Extract information stored within a powRICLPM object (internally used by print.powRICLPM and summary.powRICLPM). See "Details" for which pieces of information can be extracted. The information is presented by condition (i.e., sample size, number of time points, and ICC).

Usage

give(from, what, parameter = NULL)

Value

A data.frame.

Arguments

from

A powRICLPM object

what

A character string, denoting the information to extract, either "conditions", "estimation_problems", "results", or "names".

parameter

(optional) When what = "results", a character string denoting the parameter to extract the results for.

Details

The following information can be extracted from the powRICLPM object:

• conditions: A data.frame with the different experimental conditions per row, where each condition is defined by a unique combination of sample size, number of time points and ICC.

• estimation_problems: The proportion of fatal errors, inadmissible values, or non-converged estimations (columns) per experimental conditions (row).

• results: The average estimate (average), minimum estimate (minimum), standard deviation of parameter estimates (SD), the average standard error (SEavg), the mean square error (MSE), the average width of the confidence interval (accuracy), the coverage rate (coverage), and the proportion of times the p-value was lower than the significance criterion (power). It requires setting the parameter = "..." argument.

• names: The parameter names in the condition with the least parameters (i.e., parameter names that apply to each experimental condition).

Examples

# \dontshow{
load(system.file("extdata", "out_preliminary.RData", package = "powRICLPM"))
# }
# Return data frame with number of estimation problems per experimental condition
give(out_preliminary, "estimation_problems")

# Return data frame with performance measures for "wB2~wA1" per experimental condition
give(out_preliminary, "results", parameter = "wB2~wA1")

# Return character vector with parameter names
give(out_preliminary, "names")