Skip to content

Commit

Permalink
Promoted VCF 4.4 out of draft status
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Cameron committed Jan 27, 2023
1 parent e286c6c commit 46fff75
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 14 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PDFS = BCFv1_qref.pdf \
VCFv4.1.pdf \
VCFv4.2.pdf \
VCFv4.3.pdf \
VCFv4.4.draft.pdf
VCFv4.4.pdf

pdf: $(PDFS:%=new/%)

Expand All @@ -29,7 +29,7 @@ new/SAMtags.pdf diff/SAMtags.pdf: SAMtags.tex new/SAMtags.ver
new/VCFv4.1.pdf diff/VCFv4.1.pdf: VCFv4.1.tex new/VCFv4.1.ver
new/VCFv4.2.pdf diff/VCFv4.2.pdf: VCFv4.2.tex new/VCFv4.2.ver
new/VCFv4.3.pdf diff/VCFv4.3.pdf: VCFv4.3.tex new/VCFv4.3.ver
new/VCFv4.4.draft.pdf diff/VCFv4.4.draft.pdf: VCFv4.4.draft.tex new/VCFv4.4.draft.ver
new/VCFv4.4.pdf diff/VCFv4.4.pdf: VCFv4.4.tex new/VCFv4.4.ver

# Set LATEXMK to "scripts/rerun.sh new/$* $(PDFLATEX)" to use the previous
# controller script, e.g., if your installation does not have latexmk.
Expand All @@ -48,7 +48,7 @@ new/BEDv1.pdf: LATEXMK_ENGINE = --lualatex

new/CRAMv2.1.ver new/CRAMv3.ver: img/CRAMFileFormat2-1-fig001.png img/CRAMFileFormat2-1-fig002.png img/CRAMFileFormat2-1-fig003.png img/CRAMFileFormat2-1-fig004.png img/CRAMFileFormat2-1-fig005.png img/CRAMFileFormat2-1-fig006.png img/CRAMFileFormat2-1-fig007.png

new/VCFv4.1.ver new/VCFv4.2.ver new/VCFv4.3.ver new/VCFv4.4.draft.ver: img/all_orientations-400x296.png img/derivation-400x267.png img/erosion-400x211.png img/inserted_contig-400x247.png img/inserted_sequence-400x189.png img/inversion-400x95.png img/microhomology-400x248.png img/multiple_mates-400x280.png img/phasing-400x259.png img/reciprocal_rearrangement-400x192.png img/telomere-400x251.png
new/VCFv4.1.ver new/VCFv4.2.ver new/VCFv4.3.ver new/VCFv4.4.ver: img/all_orientations-400x296.png img/derivation-400x267.png img/erosion-400x211.png img/inserted_contig-400x247.png img/inserted_sequence-400x189.png img/inversion-400x95.png img/microhomology-400x248.png img/multiple_mates-400x280.png img/phasing-400x259.png img/reciprocal_rearrangement-400x192.png img/telomere-400x251.png

new/%.ver: %.tex | new
scripts/genversion.sh $^ > $@
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ It has no formal definition and several incompatible variants, but is described
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.
**[VCFv4.4.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]** and **[VCFv4.3.tex]** describe their predecessors.
These formats are discussed on the [vcftools-spec mailing list][vcfspec-ml].

**[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.
Expand Down Expand Up @@ -74,7 +73,7 @@ Transfer protocols
[VCFv4.1.tex]: http://samtools.github.io/hts-specs/VCFv4.1.pdf
[VCFv4.2.tex]: http://samtools.github.io/hts-specs/VCFv4.2.pdf
[VCFv4.3.tex]: http://samtools.github.io/hts-specs/VCFv4.3.pdf
[VCFv4.4.draft.tex]: http://samtools.github.io/hts-specs/VCFv4.4.draft.pdf
[VCFv4.4.tex]: http://samtools.github.io/hts-specs/VCFv4.4.pdf
[BCFv1_qref.tex]: http://samtools.github.io/hts-specs/BCFv1_qref.pdf
[BCFv2_qref.tex]: http://samtools.github.io/hts-specs/BCFv2_qref.pdf
[BEDv1.tex]: https://samtools.github.io/hts-specs/BEDv1.pdf
Expand Down
File renamed without changes.
9 changes: 2 additions & 7 deletions VCFv4.4.draft.tex → VCFv4.4.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@
\usepackage[margin=0.75in]{geometry}
\usepackage[pdfborder={0 0 0}]{hyperref}

\usepackage{draftwatermark}
\SetWatermarkAngle{315}
\SetWatermarkText{PRELIMINARY}
\SetWatermarkScale{4}

\usepackage{listings}
\lstset{
basicstyle=\ttfamily,
Expand All @@ -22,8 +17,8 @@
\renewcommand{\thefootnote}{\fnsymbol{footnote}}

\begin{document}
\input{VCFv4.4.draft.ver}
\title{\huge \color{red} DRAFT SPEC SUBJECT TO CHANGE \\ Release Candidate 2 \\ The Variant Call Format Specification \\ \vspace{0.5em} \large VCFv4.4 and BCFv2.2}
\input{VCFv4.4.ver}
\title{The Variant Call Format Specification \\ \vspace{0.5em} \large VCFv4.4 and BCFv2.2}
\date{\headdate}
\maketitle
\begin{quote}\small
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Specifications:
- [VCF v4.1](VCFv4.1.pdf)
- [VCF v4.2](VCFv4.2.pdf)
- [VCF v4.3](VCFv4.3.pdf)
- [VCF v4.4 draft](VCFv4.4.draft.pdf)
- [VCF v4.4](VCFv4.4.pdf)
- [BED v1](BEDv1.pdf)
- [crypt4gh](crypt4gh.pdf)
- [Htsget](htsget.html)
Expand Down

0 comments on commit 46fff75

Please sign in to comment.