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

    Interface AlignmentRecordInput

    Input fields for creating an alignment record.

    The sequence and quality fields accept either a plain string or an existing GenotypeString. The format discriminant ("sam" or "bam") must be provided by the caller since the constructor doesn't know which parser produced the record.

    interface AlignmentRecordInput {
        format: "sam" | "bam";
        id: string;
        sequence: string | GenotypeString;
        quality: string | GenotypeString;
        qualityEncoding: QualityEncoding;
        flag: number;
        referenceSequence: string;
        position: number;
        mappingQuality: number;
        cigar: string;
        description?: string;
        lineNumber?: number;
    }
    Index

    Properties

    format: "sam" | "bam"
    id: string
    sequence: string | GenotypeString
    quality: string | GenotypeString
    qualityEncoding: QualityEncoding
    flag: number
    referenceSequence: string
    position: number
    mappingQuality: number
    cigar: string
    description?: string
    lineNumber?: number