Skip to content
master
Switch branches/tags
Code

Latest commit

Remove enhancement and suggestion sections as they have been created
as issues on the hts-specs repository instead:

- #594 Request reads from more than one ID at a time
- #595 Allow clients to provide a suggested data block size to the server
- #596 Add a way to request reads in GA4GH binary format
- #597 `format` should probably be specified as a (comma separated?) list
df96264

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Mar 7, 2014

SAM/BAM and related specifications

These documents are maintained by the Large Scale Genomics work stream of the Global Alliance for Genomics & Health (GA4GH). Information on GA4GH procedures and how to get involved is available here. Lists of contributors and acknowledgements can generally be found in each individual specification document.

Links in bold point to the corresponding PDFs on this repository's GitHub Pages website.

Please request improvements or report errors using this repository, but see also the list of maintainers if you need to contact them directly. See the build instructions for an explanation of how to generate the PDF documents from their source text.

Alignment data files

SAMv1.tex is the canonical specification for the SAM (Sequence Alignment/Map) format, BAM (its binary equivalent), and the BAI format for indexing BAM files. SAMtags.tex is a companion specification describing the predefined standard optional fields and tags found in SAM, BAM, and CRAM files. These formats are discussed on the samtools-devel mailing list.

CRAMv3.tex is the canonical specification for the CRAM format, while CRAMv2.1.tex describes its now-obsolete predecessor. Further details can be found at ENA's CRAM toolkit page and GA4GH's CRAM page. CRAM discussions can also be found on the samtools-devel mailing list.

The tabix.tex and CSIv1.tex quick references summarize more recent index formats: the tabix tool indexes generic textual genome position-sorted files, while CSI is htslib's successor to the BAI index format.

Unaligned sequence data files

We do not define or endorse any dedicated unaligned sequence data format. Instead we recommend storing such data in one of the alignment formats (SAM, BAM, or CRAM) with the unmapped flag set. However for completeness, we list the commonest formats below with external links.

FASTA is an early sequence-only format originally defined by William Pearson's tool of the same name.

FASTQ was designed as a replacement for FASTA, combining the sequence and quality information in the same file. It has no formal definition and several incompatible variants, but is described in a paper by Cock et al.

Variant calling data files

VCFv4.3.tex is the canonical specification for the Variant Call Format and its textual (VCF) and binary (BCF) encodings, while VCFv4.1.tex and VCFv4.2.tex describe their predecessors. VCFv4.4.draft.tex is a working draft of the upcoming version of VCF format and is under active revision. These formats are discussed on the vcftools-spec mailing list.

BCFv1_qref.tex summarizes the obsolete BCF1 format historically produced by samtools. This format is no longer recommended for use, as it has been superseded by the more widely-implemented BCF2.

BCFv2_qref.tex is a quick reference describing just the layout of data within BCF2 files.

File encryption

crypt4gh.tex is the canonical specification of the crypt4gh format which can be used to wrap existing file formats in an encryption layer.

Transfer protocols

Htsget.md describes the hts-get retrieval protocol, which enables parallel streaming access to data sharded across multiple URLs or files.

Refget.md enables access to reference sequences using an identifier derived from the sequence itself.

About

Specifications of SAM/BAM and related high-throughput sequencing file formats

Resources

Releases

No releases published

Packages

No packages published