atable: format_tests – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

format_tests

Formats hypothesis test results

Description

The results of function two_sample_htest and multi_sample_htest must be formated before printing. format_tests does this.

Usage

format_tests(x, ...)

## S3 method for class 'htest'
format_tests(x, format_tests.htest = NULL, ...)

## S3 method for class 'htest_with_effect_size'
format_tests(x, format_tests.htest_with_effect_size = NULL, ...)

## Default S3 method:
format_tests(x, ...)

Arguments

`x`	An object.
`...`	Passed from and to other methods.
`format_tests.htest`	Either `NULL` or a function. Default is `NULL`. If a function, then it will replace `format_tests.htest`. The function must mimic `format_tests`: arguments are `x` and the ellipsis ... . Result is a data.frame with 1 rows and unique colnames.
`format_tests.htest_with_effect_size`	Analog to argument format_tests.htest

Details

This function defines which test results are printed in the final table and how they are formated.

The format depends on the class x. See section methods.

If you are not pleased with the current format you may alter these functions. But you must keep the original output-format, see section Value. Function check_format_tests checks if the output of format_tests is suitable for further processing.

Value

A non-empty data.frame with one row. See also function check_format_tests.

Methods (by class)

htest: Defines how to format class htest. Returns a data.frame with 1 rows. Column p contains the p-value of the x.
htest_with_effect_size: Defines how to format class htest_with_effect_size. Returns a data.frame with 1 rows. Column p contains the p-value of the x. Column stat contains the teststatistic. Column Effect Size (CI) contains a effect size and its 95% Confidence interval.
default: Tries to cast to data.frame with one row. Uses the names of the list as colnames.

atable

Create Tables for Reporting Clinical Trials

v0.1.10

GPL-3

Authors

Armin Ströbel [aut, cre] (<https://orcid.org/0000-0002-6873-5332>), Alan Haynes [aut] (<https://orcid.org/0000-0003-1374-081X>)

Initial release