DiscreteTestResultsSummary: Discrete Test Results Summary Class

DiscreteTestResultsSummaryR Documentation

Discrete Test Results Summary Class

Description

This is the class used by DiscreteTests for summarising DiscreteTestResults objects. It contains the summarised objects itself, as well as a summary tibble object as private members. Both can be extracted by public methods.

Methods

Public methods


summary.DiscreteTestResults$new()

Creates a new summary.DiscreteTestResults object.

Usage
summary.DiscreteTestResults$new(test_results)
Arguments
test_results

the DiscreteTestResults class object to be summarised.


summary.DiscreteTestResults$get_test_results()

Returns the underlying DiscreteTestResults object.

Usage
summary.DiscreteTestResults$get_test_results()
Returns

A DiscreteTestResults R6 class object.


summary.DiscreteTestResults$get_summary_table()

Returns the summary table of the underlying DiscreteTestResults object.

Usage
summary.DiscreteTestResults$get_summary_table()
Returns

A data frame.


summary.DiscreteTestResults$print()

Prints the summary.

Usage
summary.DiscreteTestResults$print(...)
Arguments
...

further arguments passed to print.data.frame.

Returns

Prints a summary table of the tested null hypotheses. The object itself is invisibly returned.


summary.DiscreteTestResults$clone()

The objects of this class are cloneable with this method.

Usage
summary.DiscreteTestResults$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

# binomial tests
obj <- binom_test_pv(0:5, 5, 0.5)
# create DiscreteTestResultsSummary object
res <- DiscreteTestResultsSummary$new(obj)
# print summary
print(res)
# extract summary table
res$get_summary_table()


DiscreteTests documentation built on Sept. 2, 2026, 9:06 a.m.