print.poweRbal_data {poweRbal} | R Documentation |
Print and summary method for poweRbal_data objects
Description
This function prints the contents of an object of class poweRbal_data
.
It provides a brief summary of the object structure and its contents.
This function provides a summary of an object of class poweRbal_data
.
It offers a high-level overview of the contents and their structure.
Usage
## S3 method for class 'poweRbal_data'
print(x, ...)
## S3 method for class 'poweRbal_data'
summary(object, ...)
Arguments
x |
An object of class poweRbal_data , which is a list containing
one mandatory element, power , and several optional elements:
-
power : A numeric matrix containing the power values (one row per
TSS and one column per alternative model).
-
accept_regions : A numeric matrix containing information on the
region of acceptance (one row per TSS and four columns).
-
CIradius : A numeric matrix containing the confidence interval
radii (one row per TSS and one column per alternative model).
-
actual_sample_sizes : A numeric vector containing the actual sample
sizes under each alternative model, as some models do not always
successfully generate trees.
-
alt_model_params : A numeric vector (one element per alternative
model) containing the values of a tree model parameter. This is only
suitable if the alternative models all belong to the same tree model
family and differ only in one parameter.
Other input data from the powerComp() function, such as tss ,
null_model , alt_models , n , distribs ,
N_null , N_alt , test_type , correction , and
sig_lvl .
|
... |
Additional arguments passed to the print or summary
function.
|
object |
An object of class poweRbal_data (see x for
more details).
|
Value
print.poweRbal_data
No return value, as the primary purpose
of this function is the side effect (printing).
summary.poweRbal_data
No return value, as the primary purpose
of this function is the side effect (printing summary).
Examples
# Printing a 'poweRbal_data' object:
pc1 <- powerComp(tss = c("Sackin", "Colless", "B1I"),
alt_models = list(list("aldous",-1), "pda", "etm"),
n = 8L, N_null = 40L, N_alt = 20L)
pc1
# Summary of a 'poweRbal_data' object:
summary(pc1)
[Package
poweRbal version 0.0.1.1
Index]