seq_test_ranking: Rank sequence test results

View source: R/method-grim-sequence.R

seq_test_rankingR Documentation

Rank sequence test results

Description

Run this function after generating a sequence with seq_endpoint_df() or seq_distance_df() and testing it with one of scrutiny's mapping functions, such as grim_map(). It will rank the test's consistent and inconsistent results by their positions in the sequence.

Usage

seq_test_ranking(x, explain = TRUE)

Arguments

x

Data frame.

explain

If TRUE (the default), results come with an explanation.

Details

The function checks the provenance of the test results and throws a warning if it's not correct.

Value

A tibble (data frame). The function will also print an explanation of the results. See examples.

Examples

seq_distance_df(.from = "0.00", n = 50) %>%
  grim_map() %>%
  seq_test_ranking()

scrutiny documentation built on Sept. 22, 2024, 9:06 a.m.