aboutsummaryrefslogtreecommitdiff
path: root/workflows/pubseq/normalize/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'workflows/pubseq/normalize/README.md')
-rw-r--r--workflows/pubseq/normalize/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/workflows/pubseq/normalize/README.md b/workflows/pubseq/normalize/README.md
new file mode 100644
index 0000000..b780a68
--- /dev/null
+++ b/workflows/pubseq/normalize/README.md
@@ -0,0 +1,14 @@
+# Normalization steps
+
+This library contains generic logic to normalize (string) data and
+transforms strings to URIs. It should be applicable to data from
+any source (GenBank, ENA etc).
+
+Important: missing data should be missing or None! Do not fill
+in data by 'guessing'.
+
+When data is malformed a warning should be logged and added to the
+warning list. Functions should be small enough to return only 1
+warning!
+
+Pjotr Prins (c) 2021