Package index • statim

High Level API

Main functions for interactive use

Model definition

Verbs that describe the model you want to analyze

define_model(): Model define constructor

Model IDs

Mappers to shape the model you want to describe. Formula also allowed.

x_by() `%by%`: 'Variable compared by groups' model mapping
rel(): 'Relationship between two variables' model mapping
pairwise(): 'Pairs between variables' model mapping

Multiple Inline Codes

Analogue to I(), but only captures the expression and accepts multiple inline codes.

inlines(): Inline multiple expressions in a model ID

H-test pipeline

Verbs that build and execute the test pipeline

prepare_test(): Lazily prepare a single test
via(): Recalibrate the test method variant
update(<test_lazy>): Recalibrate arguments from the main pipeline
conclude(): Execute a lazy test pipeline

H-test executioner

Eager execution of a prepared test

TTEST(): T-Test
CORTEST(): Correlation Test

Low-level/Implementation API

Functions for building and extending test implementations

Model ID helpers

Build new model ID mappers

model_id_class(): Attach a model-ID class to an object
model_processor(): Model evaluator
model_id_info(): Extract metadata from a model ID

Implementation containers

Declare how a test runs

agendas(): Collect implementations for a test definition
baseline(): Declare the canonical implementation of a test
variant(): Declare an alternative implementation of a test

Test definition

Register a new test implementation

test_define(): Define a test implementation
HTEST_FN(): Build a hypothesis test function

Session-scoped variant management

Add or replace variants on existing test functions

plug_variant() swap_variant() clear_htest_defs(): Add or replace variants on a test function