refactor: add init, docs: add docstring to illumina.py

fulcrumgenomics · Aug 2, 2024 · cc7bada · cc7bada
1 parent 0c277d5
commit cc7bada
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/fgpyo/platform/__init__.py b/fgpyo/platform/__init__.py
diff --git a/fgpyo/platform/illumina.py b/fgpyo/platform/illumina.py
@@ -1,3 +1,15 @@
+"""
+Methods for working with Illumina-specific UMIs in SAM files
+------------------------------------
+
+The functions in this module make it easy to:
+
+* check whether a UMI is valid
+* extract UMI(s) from an Illumina-style read name
+* copy a UMI from an alignment's read name to its `RX` SAM tag
+
+"""
+
 from typing import Optional
 from typing import Set