summary.realtest_results: Summarise and Display Test Results¶

Description¶

An example (write your own which will better suit your needs) way to summarise the results returned by test_dir.

Usage¶

## S3 method for class 'realtest_results_summary'
print(x, label_fail = "fail", ...)

## S3 method for class 'realtest_results'
summary(object, label_pass = "pass", label_fail = "fail", ...)

Arguments¶


`x`	object returned by `summary.realtest_results`
`label_fail`	single string labelling failed test cases
`...`	currently ignored
`object`	list of objects of class `realtest_result`, see `E`.
`label_pass`	single string denoting the default name for unnamed prototypes

Value¶

print.realtest_results_summary returns x, invisibly.

summary.realtest_results returns an object of class realtest_results_summary which is a data frame summarising the test results, featuring the following columns:

call – the name of the function tested,
match – the name of the first matching prototype, label_pass if it is unnamed or label_fail if there is no match,
.file (optional) – the name of the source file which defined the expectation,
.line (optional) – line number,
.expr (optional) – source code of the whole tested expression.

Author(s)¶

Marek Gagolewski

See Also¶

The official online manual of realtest at https://realtest.gagolewski.com/

Related functions: test_dir

Examples¶

# r <- test_dir("~/R/realtest/inst/realtest")  # some path
# s <- summary(r)  # summary.realtest_results
# print(s)  # print.realtest_results_summary
# stopifnot(!any(s[["match"]]=="fail"))  # halt if there are failed tests