Skip to content

Commit 94500cf

Browse files
authored
Add a footnote on case-insensitivity of RG PL (PR #684)
This is not changing what is valid / permitted, and indeed this hopefully clarifies it further. However the practicality of dealing with wide-spread non-compliant data with lowercase PL values is that tools may wish to be lenient and use case-insensitive matching. Also removes test/sam/failed/hdr.RG6.sam due to explicitly testing against the use of lower-case PL fields. While strictly not conforming, it's overly harsh if we are advocating a more spec-tolerant testing regime for PL. Fixes #679.
1 parent 35bd24e commit 94500cf

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

SAMv1.tex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,9 @@ \subsection{The header section}
329329
& {\tt PG} & Programs used for processing the read group.\\\cline{2-3}
330330
& {\tt PI} & Predicted median insert size, rounded to the nearest integer.\\\cline{2-3}
331331
& {\tt PL} & Platform/technology used to produce the reads. \emph{Valid values}:
332-
{\tt CAPILLARY}, {\tt DNBSEQ} (MGI/BGI), {\tt ELEMENT}, {\tt HELICOS}, {\tt ILLUMINA}, {\tt IONTORRENT}, {\tt LS454}, {\tt ONT} (Oxford Nanopore), {\tt PACBIO} (Pacific Biosciences), {\tt SINGULAR}, {\tt SOLID}, and {\tt ULTIMA}.
332+
{\tt CAPILLARY}, {\tt DNBSEQ} (MGI/BGI), {\tt ELEMENT}, {\tt HELICOS}, {\tt ILLUMINA}, {\tt IONTORRENT}, {\tt LS454}, {\tt ONT} (Oxford Nanopore), {\tt PACBIO} (Pacific Biosciences), {\tt SINGULAR}, {\tt SOLID}, and {\tt ULTIMA}.%
333+
\footnote{The {\tt PL} value should be written in uppercase exactly as shown in this list of valid values.
334+
Tools should also accept lowercase when reading the {\tt @RG PL} field, due to the existence of public data files with lowercase {\tt PL} values.}
333335
This field should be omitted when the technology is not in this list (though the {\tt PM} field may still be present in this case) or is unknown.\\\cline{2-3}
334336
& {\tt PM} & Platform model. Free-form text providing further details of the platform/technology used.\\\cline{2-3}
335337
& {\tt PU} & Platform unit (e.g., flowcell-barcode.lane for Illumina or slide for SOLiD). Unique identifier.\\\cline{2-3}

test/sam/failed/hdr.RG6.sam

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)