# CRAM (file format)

Compressed Reference-oriented Alignment Map (CRAM) is a compressed columnar file format for storing biological sequences aligned to a reference sequence, initially devised by Markus Hsi-Yang Fritz et al.
CRAM was designed to be an efficient reference-based alternative to the Sequence Alignment Map (SAM) and Binary Alignment Map (BAM) file formats. It optionally uses a genomic reference to describe differences between the aligned sequence fragments and the reference sequence, reducing storage costs. Additionally each column in the SAM format is separated into its own blocks, improving compression ratio. CRAM files typically vary from 30 to 60% smaller than BAM, depending on the data held within them.
Implementations of CRAM exist in htsjdk, htslib, JBrowse, and Scramble.
The file format specification is maintained by the Global Alliance for Genomics and Health (GA4GH) with the specification document available from the EBI cram toolkit page.

## File format

The basic structure of a CRAM file is a series of containers, the first of which holds a compressed copy of the SAM header. Subsequent containers consist of a container Compression Header followed by a series of slices which in turn hold the alignment records themselves, formatted as a series of blocks.
CRAM file:
    Magic numberContainer (SAM header)Container (Data)...Container (Data)Container (EOF)
Container:
    Container HeaderCompression HeaderSlice...Slice
Slice:
    Slice HeaderBlockBlock...Block
CRAM constructs records from a set of data series, describing the components of an alignment. The container Compression Header specifies which data series is encoded in which block, what codec will be used, and any codec specific meta-data (for example a table of Huffman symbol code lengths). While data series can be mixed together within the same block, keeping them separate usually improves compression and provides the opportunity for efficient selective decoding where only some data types are required.
Selective access to a CRAM file is granted via the index (with file-name suffix ".crai"). On chromosome and position sorted data this indicates which region is covered by each slice. On unsorted data the index may be used to simply fetch the Nth container. Selective decoding may also be achieved using the Compression Header to skip specified data series if partial records are required.

## History

| Year | Version(s) | Notes |
| 2010-11 | pre-CRAM | Initial paper describing the reference based format. This did not use the name CRAM, but called it mzip. This software was implemented in Python as a prototype and demonstration of the basic concepts. |
| 2011-12 | 0.3–0.86 | Vadim Zalunin of the European Bioinformatics Institute (EBI) produced the first implementation named CRAM as a package called CRAMtools, written in the Java programming language. |
| 2012 | 1.0 | Implemented in Java CRAMtools. |
| 2013 | | C implementation added to the Scramble tool, by James Bonfield of the Wellcome Sanger Institute. |
| 2013 | 2.0 | Changes included support for more than one reference per slice (useful with highly fragmented assemblies), better encoding of SAM auxiliary tags, splitting soft-clip and inserted bases into their own data-series, meta-data to track the number of records and bases per slice, and corrections to the BF (BAM flag) data-series. |
| 2013 | | Added to htslib (0.2.0). |
| 2014 | 2.1 | Added EOF blocks, to help identify truncated files. |
| 2014 | | Added to htsjdk (1.127). |
| 2014 | 3.0 | Inclusion of lzma and rANS codecs for block compression, along with multiple checksums for ensuring data integrity |
| 2018 | | JavaScript implementation as part of JBrowse (1.15.0), by Rob Buels. |
| 2021 | | Rust implementation in Noodles |
| 2023 | 3.1 | Officially adopted. (Draft from 2019) |
CRAM version 4.0 exists as a prototype in Scramble, initially demonstrated in 2015, but has yet to be adopted as a standard.