Genotype API Documentation - v0.1.0
    Preparing search index...

    Variable SAMUtilsConst

    SAMUtils: {
        detectFormat(data: string): boolean;
        decodeFlag(
            flag: number,
        ): {
            isPaired: boolean;
            isProperPair: boolean;
            isUnmapped: boolean;
            isMateUnmapped: boolean;
            isReverse: boolean;
            isMateReverse: boolean;
            isFirstInPair: boolean;
            isSecondInPair: boolean;
            isSecondary: boolean;
            isQCFail: boolean;
            isDuplicate: boolean;
            isSupplementary: boolean;
        };
        parseCIGAROperations(
            cigar: string,
        ): { operation: string; length: number }[];
        calculateReferenceSpan(cigar: string): number;
    } = ...

    SAM utility functions for format detection and operations

    Type Declaration

    • detectFormat: function
      • Detect if string contains SAM format data

        Parameters

        • data: string

        Returns boolean

    • decodeFlag: function
      • Decode SAM flag into human-readable components

        Parameters

        • flag: number

        Returns {
            isPaired: boolean;
            isProperPair: boolean;
            isUnmapped: boolean;
            isMateUnmapped: boolean;
            isReverse: boolean;
            isMateReverse: boolean;
            isFirstInPair: boolean;
            isSecondInPair: boolean;
            isSecondary: boolean;
            isQCFail: boolean;
            isDuplicate: boolean;
            isSupplementary: boolean;
        }

    • parseCIGAROperations: function
      • Parse CIGAR string into operations

        Parameters

        • cigar: string

        Returns { operation: string; length: number }[]

    • calculateReferenceSpan: function
      • Calculate alignment span on reference

        Parameters

        • cigar: string

        Returns number