print.possa_sim_df {POSSA}

Print sim results

Description

Prints information about the simulated p values created by the POSSA::sim function. This is an extension (method) of the base R print function, so it can be called simply as print().

Usage

## S3 method for class 'possa_sim_df'
print(x, group_by = NULL, descr_cols = TRUE, descr_func = summary, ...)

Arguments

x

The data.frame returned by the POSSA::sim function.

group_by

When given as a character element or vector, specifies the factors by which to group the descriptives: the x data will be divided into parts by these factors and these parts will be analyzed separately, with descriptives printed per each part. By default (NULL), it identifies factors, if any, given to the sim function (via fun_obs) that created the given x data.

descr_cols

When given as a character element or vector, specifies the factors for which descriptive data should be shown (by group, if applicable). By default NULL, it identifies (similar as group_by) factors, if any, given to the sim function (via fun_obs) that produced the given x data.

descr_func

Function used for printing descriptives (see descr_cols). By default, it uses the summary (base) function.

...

(Allow additional arguments for technical reasons.)

Value

Returns nothing (NULL); this method serves only to print information to the console.

See Also

sim