check_assay_order: Check that assays are ordered by window period

Description Usage Arguments

View source: R/assay_dynamics.R

Description

Given a list (format: character vector of names) of assays, compare pairs of sequential assays using which_is_faster to ensure that they are ordered correctly. If the order is correct, then TRUE will be returned. If not, then FALSE will be returned and a warning will be raised if verbose = TRUE.

Usage

1
2
3
4
5
check_assay_order(
  list_of_assays,
  short_window_period_first = TRUE,
  verbose = TRUE
)

Arguments

list_of_assays

A character vector specifying the names of the assays. The order of this list will be checked.

short_window_period_first

If True, check that the vector is ordered from the assay with the shortest window period to the assay with the longest window period.

verbose

If the order is incorrect, a warning will be raised specifying each sequential pair that is incorrectly ordered.


philliplab/tsic documentation built on June 26, 2020, 7:55 p.m.