{"id":13751570,"url":"https://github.com/samtools/hts-specs","last_synced_at":"2026-04-07T13:32:17.317Z","repository":{"id":2674569,"uuid":"3666509","full_name":"samtools/hts-specs","owner":"samtools","description":"Specifications of SAM/BAM and related high-throughput sequencing file formats","archived":false,"fork":false,"pushed_at":"2025-11-04T23:09:50.000Z","size":48822,"stargazers_count":688,"open_issues_count":215,"forks_count":179,"subscribers_count":100,"default_branch":"master","last_synced_at":"2025-11-21T04:05:09.765Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://samtools.github.io/hts-specs/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samtools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2012-03-09T01:58:32.000Z","updated_at":"2025-11-14T15:00:21.000Z","dependencies_parsed_at":"2023-07-05T19:02:07.516Z","dependency_job_id":"c0362066-7de4-43f1-b4b6-fcbce35c453e","html_url":"https://github.com/samtools/hts-specs","commit_stats":{"total_commits":643,"total_committers":74,"mean_commits":8.68918918918919,"dds":0.880248833592535,"last_synced_commit":"144e32acb582b414a281bf9dc06223b43609a489"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/samtools/hts-specs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samtools%2Fhts-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samtools%2Fhts-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samtools%2Fhts-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samtools%2Fhts-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samtools","download_url":"https://codeload.github.com/samtools/hts-specs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samtools%2Fhts-specs/sbom","scorecard":{"id":798245,"data":{"date":"2025-08-11","repo":{"name":"github.com/samtools/hts-specs","commit":"b5341fbb5181cc7811c10c741a682149ab0cccf8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/pr-comment.yaml:1","Warn: no topLevel permission defined: .github/workflows/pr-pdfs-close.yaml:1","Warn: no topLevel permission defined: .github/workflows/pr-pdfs.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":7,"reason":"4 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":4,"reason":"Found 11/26 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-comment.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/samtools/hts-specs/pr-comment.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-pdfs.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/samtools/hts-specs/pr-pdfs.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-pdfs.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/samtools/hts-specs/pr-pdfs.yaml/master?enable=pin","Warn: containerImage not pinned by hash: .circleci/Dockerfile:1: pin your Docker image by updating blang/latex:ubuntu to blang/latex:ubuntu@sha256:2c32abc3555a01e180528d542955e2730f7f3793cdeba49b1655de9b897cbafb","Warn: npmCommand not pinned by hash: .circleci/Dockerfile:16","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T09:38:29.617Z","repository_id":2674569,"created_at":"2025-08-23T09:38:29.618Z","updated_at":"2025-08-23T09:38:29.618Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31515144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T09:00:48.822Z","updated_at":"2026-04-07T13:32:17.170Z","avatar_url":"https://github.com/samtools.png","language":"TeX","funding_links":[],"categories":["Ranked by starred repositories"],"sub_categories":[],"readme":"SAM/BAM and related specifications\n==================================\n\nThese documents are maintained by the Large Scale Genomics work stream of the Global Alliance for Genomics \u0026 Health ([GA4GH][GA4GH.org]).\nInformation on GA4GH procedures and how to get involved is [available here][LSG-wiki].\nLists of contributors and acknowledgements can generally be found in each individual specification document.\n\nLinks **in bold** point to the corresponding PDFs on this repository's [GitHub Pages website][hts-specs].\n\nPlease request improvements or report errors using this repository, but see also [the list of maintainers](MAINTAINERS.md) if you need to contact them directly.\nSee the [build instructions](MAINTAINERS.md#generating-pdf-specification-documents) for an explanation of how to generate the PDF documents from their source text.\n\nAlignment data files\n--------------------\n\n**[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.\n**[SAMtags.tex]** is a companion specification describing the predefined standard optional fields and tags found in SAM, BAM, and CRAM files.\nThese formats are discussed on the [samtools-devel mailing list][samdev-ml].\n\n**[CRAMv3.tex]** is the canonical specification for the CRAM format, while **[CRAMv2.1.tex]** describes its now-obsolete predecessor.\n**[CRAMcodecs.tex]** contains details of the CRAM custom compression codecs.\nFurther details can be found at [ENA's CRAM toolkit page][ena-cram] and [GA4GH's CRAM page][ga4gh-cram].\nCRAM discussions can also be found on the [samtools-devel mailing list][samdev-ml].\n\nThe **[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.\n\n### Unaligned sequence data files\n\nWe do not define or endorse any dedicated unaligned sequence data format.\nInstead we recommend storing such data in one of the alignment formats (SAM, BAM, or CRAM) with the unmapped flag set.\nHowever for completeness, we list the commonest formats below with external links.\n\n[FASTA] is an early sequence-only format originally defined by William Pearson's tool of the same name.\n\n[FASTQ] was designed as a replacement for FASTA, combining the sequence and quality information in the same file.\nIt has no formal definition and several incompatible variants, but is described in a paper by Cock et al.\n\nVariant calling data files\n--------------------------\n\n**[VCFv4.5.tex]** is the canonical specification for the Variant Call Format and its textual (VCF) and binary (BCF) encodings, while **[VCFv4.1.tex]**, **[VCFv4.2.tex]**, **[VCFv4.3.tex]** and **[VCFv4.4.tex]** describe their predecessors.\nThese formats are discussed on the [vcftools-spec mailing list][vcfspec-ml].\n\n**[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.\n\n**[BCFv2_qref.tex]** is a quick reference describing just the layout of data within BCF2 files.\n\nDiscrete genomic feature data files\n-----------------------------------\n\n**[BEDv1.tex]** is the canonical specification for the GA4GH Browser Extensible Data (BED) format.\n\nFile encryption\n---------------\n\n**[crypt4gh.tex]** is the canonical specification of the crypt4gh format which can be used to wrap existing file formats in an encryption layer.\n\nTransfer protocols\n------------------\n\n**[Htsget.md]** describes the _hts-get_ retrieval protocol, which enables parallel streaming access to data sharded across multiple URLs or files.\n\n**[Refget.md]** enables access to reference sequences using an identifier derived from the sequence itself.\n\n[GA4GH.org]:    https://www.ga4gh.org/\n[LSG-wiki]:     https://github.com/ga4gh/large-scale-genomics-wiki/wiki\n\n[SAMv1.tex]:    http://samtools.github.io/hts-specs/SAMv1.pdf\n[SAMtags.tex]:  http://samtools.github.io/hts-specs/SAMtags.pdf\n[CRAMv2.1.tex]: http://samtools.github.io/hts-specs/CRAMv2.1.pdf\n[CRAMv3.tex]:   http://samtools.github.io/hts-specs/CRAMv3.pdf\n[CRAMcodecs.tex]: http://samtools.github.io/hts-specs/CRAMcodecs.pdf\n[CSIv1.tex]:    http://samtools.github.io/hts-specs/CSIv1.pdf\n[tabix.tex]:    http://samtools.github.io/hts-specs/tabix.pdf\n[VCFv4.1.tex]:  http://samtools.github.io/hts-specs/VCFv4.1.pdf\n[VCFv4.2.tex]:  http://samtools.github.io/hts-specs/VCFv4.2.pdf\n[VCFv4.3.tex]:  http://samtools.github.io/hts-specs/VCFv4.3.pdf\n[VCFv4.4.tex]:  http://samtools.github.io/hts-specs/VCFv4.4.pdf\n[VCFv4.5.tex]: https://samtools.github.io/hts-specs/VCFv4.5.pdf\n[BCFv1_qref.tex]: http://samtools.github.io/hts-specs/BCFv1_qref.pdf\n[BCFv2_qref.tex]: http://samtools.github.io/hts-specs/BCFv2_qref.pdf\n[BEDv1.tex]:    https://samtools.github.io/hts-specs/BEDv1.pdf\n[crypt4gh.tex]: http://samtools.github.io/hts-specs/crypt4gh.pdf\n[Htsget.md]:    http://samtools.github.io/hts-specs/htsget.html\n[Refget.md]:    https://samtools.github.io/hts-specs/refget.html\n\n[ena-cram]:   http://www.ebi.ac.uk/ena/about/cram_toolkit\n[ga4gh-cram]: https://www.ga4gh.org/cram/\n[htslib]:     https://github.com/samtools/htslib\n[samtools]:   https://github.com/samtools/samtools\n[hts-specs]:  http://samtools.github.io/hts-specs/\n\n[samdev-ml]:  https://lists.sourceforge.net/lists/listinfo/samtools-devel\n[vcfspec-ml]: https://lists.sourceforge.net/lists/listinfo/vcftools-spec\n\n[FASTA]:      https://en.wikipedia.org/wiki/FASTA_format\n[FASTQ]:      https://academic.oup.com/nar/article/38/6/1767/3112533\n\n\u003c!-- vim:set linebreak: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamtools%2Fhts-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamtools%2Fhts-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamtools%2Fhts-specs/lists"}