run_custom_test: Run a Custom Test using the ValidMind Framework

View source: R/custom_tests.R

run_custom_testR Documentation

Run a Custom Test using the ValidMind Framework

Description

This function runs a custom test using the ValidMind framework through Python's 'validmind.vm_models'. It retrieves a custom test by 'test_id', executes it with the provided 'inputs', and optionally displays the result. The result is also logged.

Usage

run_custom_test(test_id, inputs, test_registry, show = FALSE)

Arguments

test_id

A string representing the ID of the custom test to run.

inputs

A list of inputs required for the custom test.

test_registry

A reference to the test register object which provides the custom test class.

show

A logical value. If TRUE, the result will be displayed. Defaults to FALSE.

Value

An object representing the result of the test, with an additional log function.

Examples

## Not run: 
result <- run_custom_test("test123", my_inputs, test_registry, show = TRUE)

## End(Not run)

validmind documentation built on April 4, 2025, 5:05 a.m.