R/verify.sequence.dictionary.R

Defines functions verify.sequence.dictionary

Documented in verify.sequence.dictionary

#' verify.sequence.dictionary
#' 
#' @inheritParams verify.fasta.index
#'
#' @description
#' 	 Verify that sequence dictionary exists for a fasta file.
#'
#' @return dict.exists Logical indicating if sequence dictionary files were found (only returned if error set to FALSE)
#'
#'
verify.sequence.dictionary <- function(fasta.file, error = FALSE) {
    
    fasta.file.extension <- tools::file_ext(fasta.file);
    
    dict.file <- gsub(
        pattern = paste0('.', fasta.file.extension, '$'), 
        replacement = '.dict', 
        fasta.file
    );
    
    dict.exists <- file.exists(dict.file);
    
    if(error) {
        
        if( !dict.exists ) {
            error.message <- paste('Sequence dictionary not found for file', fasta.file,  '- try running GATK CreateSequenceDictionary.');
            stop(error.message);
        }
        
    } else {
        return(dict.exists);
    }
    
}

Try the varitas package in your browser

Any scripts or data that you put into this service are public.

varitas documentation built on Nov. 14, 2020, 1:07 a.m.