diff README.md @ 6:d4ee992c85f0 draft default tip

planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/dorado commit 4e9b34685eeea001562ec29e1f10f5ee2eeca19c
author galaxy-australia
date Tue, 15 Apr 2025 07:05:05 +0000
parents 7c47b3c9e493
children
line wrap: on
line diff
--- a/README.md	Mon Nov 11 03:05:46 2024 +0000
+++ b/README.md	Tue Apr 15 07:05:05 2025 +0000
@@ -46,3 +46,41 @@
     > tool-data/dorado_models.loc.sample
 ```
 
+## Kits and Barcodes
+
+The list of acceptable kits and barcodes is not specified in the Dorado
+documentation.
+
+A list of all sequencing kits is in [`kits.cpp`](https://github.com/nanoporetech/dorado/blob/master/dorado/models/kits.cpp)
+
+Parsed into XML with the following GNU Awk program:
+
+```bash
+gawk '
+/namespace kit/ { in_kit_namespace = 1 } 
+in_kit_namespace && /codes_map/ { in_map = 1; print "Entering kit::codes_map" } 
+in_map && /^\s*\{/ { 
+    if (match($0, /\{\s*KC::[A-Z0-9_]+,\s*\{\s*"([^"]+)"/, m)) 
+        print "            <option value=\"" m[1] "\">" m[1] "</option>"; 
+} 
+/^\s*};/ { 
+    if (in_map) { 
+        print "Exiting kit::codes_map"; 
+        exit 
+    } 
+}' kits.cpp
+```
+
+I believe the allowed barcodes are in [`barcode_kits.cpp`](https://github.com/nanoporetech/dorado/blob/master/dorado/utils/barcode_kits.cpp).
+
+Parsed into XML with the following GNU Awk program:
+
+```bash
+gawk '
+/kit_info_map/ { in_map = 1 } 
+in_map && /^\s*\{/ { 
+    if (match($0, /^\s*\{\s*"([^"]+)",/, m)) 
+        print "            <option value=\"" m[1] "\">" m[1] "</option>"; 
+} 
+/^\s*};/ { if (in_map) exit }' barcode_kits.cpp
+```