R/fixMetadata.R

Defines functions fixMetadata

Documented in fixMetadata

#' fix metadata for an MAlignmentsList or MVRangesList, if needed and possible.
#' 
#' This function is punishingly simple -- it just calls validMetadata() and
#' assigns attr('fixedMeta') from the result. If no fixing is required, the 
#' object's existing metadata is used. The object (with fixed metadata) is 
#' then returned. If automatic fixes are impossible, a message is generated.
#' 
#' @param x   an MAlignmentsList or MVRangesList
#'
#' @return    the object, with fixed metadata (if needed and possible) 
#' 
#' @examples
#' library(MTseekerData)
#' data(RONKSvariants)
#' fixMetadata(RONKSvariants)
#' @export
fixMetadata <- function(x) {
  validated <- validMetadata(x)
  if (!validated) metadata(x) <- attr(validated, "fixedMeta")
  return(x)
}
trichelab/MTseeker documentation built on March 8, 2021, 6:20 p.m.