added list of checks to the seqspec tool

pachterlab · Sep 24, 2024 · 7accfa4 · 7accfa4
1 parent a53f0fa
commit 7accfa4
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/SEQSPEC_TOOL.md b/docs/SEQSPEC_TOOL.md
@@ -87,6 +87,8 @@ A list of checks performed:
 13. Check that the lengths of the `sequence` in every region object is between the `min_len` and `max_len` length.
 14. Check that the number of files in each `File` object for all `Read` objects are the same length.
 
+Below are a list of example errors one may encounter when checking a spec:
+
 ```bash
 # The "assay" value was not specified in the spec
 [error 1] None is not of type 'string' in spec['assay']