Skip to content

Commit

Permalink
SAM: add a sentence on case-insensitivity of RG PL (PR samtools#684)
Browse files Browse the repository at this point in the history
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 samtools#679
  • Loading branch information
jkbonfield committed May 2, 2023
1 parent 3c493e7 commit f379895
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
3 changes: 2 additions & 1 deletion SAMv1.tex
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,8 @@ \subsection{The header section}
& {\tt PI} & Predicted median insert size.\\\cline{2-3}
& {\tt PL} & Platform/technology used to produce the reads. \emph{Valid values}:
{\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 SOLID}, and {\tt ULTIMA}.
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}
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.
The values should be written as described in uppercase, however due to the existance of public data with lowercase values tools should also accept lowercase when decoding.\\\cline{2-3}
& {\tt PM} & Platform model. Free-form text providing further details of the platform/technology used.\\\cline{2-3}
& {\tt PU} & Platform unit (e.g., flowcell-barcode.lane for Illumina or slide for SOLiD). Unique identifier.\\\cline{2-3}
& {\tt SM} & Sample. Use pool name where a pool is being sequenced.\\\cline{1-3}
Expand Down
1 change: 0 additions & 1 deletion test/sam/failed/hdr.RG6.sam

This file was deleted.

0 comments on commit f379895

Please sign in to comment.