validMetadata: Ensure that the metadata caches in MAlignmentsLists and...

In trichelab/MTseeker: Bioconductor Tools for Human Mitochondrial Variant Analysis

Description

In order to avoid a lot of lengthy calculations, both MAlignmentsList and MVRangesList objects keep a cache of some relevant statistics and filenames in their metadata slot. If these caches get stale, it can cause problems.

Usage

validMetadata(x)

Arguments

x	an MAlignmentsList or an MVRangesList

Details

This function performs some sanity checks on the caches so that the above problems are unlikely to occur, provided that checkMetadataCache() is called at sensible times. This function is NOT a replacement for validObject().

Value

       TRUE or FALSE (if FALSE, attr(res)$mismatches shows why)

Examples

library(MTseekerData)
data(RONKSvariants) 
obj <- "RONKSvariants"
if (validMetadata(get(obj))) message(obj, " has valid metadata.")

trichelab/MTseeker documentation built on March 8, 2021, 6:20 p.m.