Helper functions for defining and validating the schema used by
agg_receptors() to identify unique receptors.
make_receptor_schema() creates a schema list object.
assert_receptor_schema() checks if an object is a valid schema list and throws
an error if not.
test_receptor_schema() checks if an object is a valid schema list or a
character vector (which agg_receptors can also accept) and returns TRUE
or FALSE.
make_receptor_schema(features, chains = NULL)
assert_receptor_schema(schema)
test_receptor_schema(schema)Character vector. Column names defining the features of a single receptor chain (e.g., V gene, J gene, CDR3 sequence).
Optional character vector (max length 2). Locus names (e.g.,
"TRA", "TRB") to filter by or pair. If NULL or length 1, only
filtering occurs. If length 2, pairing logic is enabled in agg_receptors().
Default: NULL.
An object to test or assert as a valid schema. Can be a list
created by make_receptor_schema or a character vector (for test_receptor_schema).
make_receptor_schema returns a list with elements features and chains.
assert_receptor_schema returns TRUE invisibly if valid, or stops execution.
test_receptor_schema returns TRUE or FALSE.