validate: Internal Helper Functions for Validation of 'AnyHermesData'...

In insightsengineering/hermes: Preprocessing, analyzing, and reporting of RNA-seq data

Internal Helper Functions for Validation of AnyHermesData Objects

Description

These functions are used internally only and therefore not exported. They work on SummarizedExperiment::SummarizedExperiment objects, and AnyHermesData objects are defined by successfully passing these validation checks.

Usage

validate_counts(object)

validate_cols(required, actual)

validate_row_data(object)

validate_col_data(object)

validate_names(object)

validate_prefix(object)

Arguments

object	(SummarizedExperiment) object to validate.
required	(character) required column names.
actual	(actual) actual column names.

Value

A character vector with the validation failure messages, or NULL in case validation passes.

Functions

• validate_counts(): validates that the first assay is counts containing non-missing, integer, non-negative values.

• validate_cols(): validates that required column names are contained in actual column names.

• validate_row_data(): validates that the object contains rowData with required columns.

• validate_col_data(): validates that the object contains colData with required columns.

• validate_names(): validates that the object contains row and column names.

• validate_prefix(): validates that the object prefix is a string and only contains alphabetic characters.

insightsengineering/hermes documentation built on Dec. 15, 2024, 8:07 a.m.