check_modeling_results: Check input modeling_results

In LieberInstitute/spatialLIBD: spatialLIBD: an R/Bioconductor package to visualize spatially-resolved transcriptomics data

Check input modeling_results

Description

This function checks that the modeling_results object has the appropriate structure. For more details please check the vignette documentation.

Usage

check_modeling_results(modeling_results)

Arguments

modeling_results

Defaults to the output of fetch_data(type = 'modeling_results'). This is a list of tables with the columns ⁠f_stat_*⁠ or ⁠t_stat_*⁠ as well as ⁠p_value_*⁠ and ⁠fdr_*⁠ plus ensembl. The column name is used to extract the statistic results, the p-values, and the FDR adjusted p-values. Then the ensembl column is used for matching in some cases. See fetch_data() for more details. Typically this is the set of reference statistics used in layer_stat_cor().

Value

The input object if all checks are passed.

See Also

Other Check input functions: check_sce(), check_sce_layer(), check_spe()

Examples

if (!exists("modeling_results")) {
    modeling_results <- fetch_data(type = "modeling_results")
}

## Check the object
xx <- check_modeling_results(modeling_results)

LieberInstitute/spatialLIBD documentation built on Dec. 19, 2024, 7:12 p.m.