From 7ea15269cb85c32e55ebcc6381de77810d898927 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Mon, 11 Apr 2022 08:37:26 +0300
Subject: Initialise the QC repository

---
 .gitignore |  1 +
 README.org | 26 ++++++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.org

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..565bfbc
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/**/*~
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..000394e
--- /dev/null
+++ b/README.org
@@ -0,0 +1,26 @@
+#+STARTUP: inlineimages
+#+TITLE: Quality Control Application
+
+** Project Goals
+
+The project seeks to handle the checking of data files for correct syntax and
+other errors before allowing the code to be uploaded.
+
+The files are *"tab-separated"* values (TSV) files, and must conform to the
+following criteria:
+
+*** Line-Level Checks
+
+- Must be tab-separated
+-
+
+*** Cell-Level Checks
+
+- No empty data cells
+- no data cells with spurious characters like `eeeee`, `5.555iloveguix`, etc.
+- decimal numbers must conform to the following criteria:
+-   - when checking an average file decimal numbers must contain exactly three places to the right side of the dot.
+-   - when checking a standard error file decimal numbers must contain six or greater places to the right side of the dot.
+-   - there must be a number to the left side of the dot (e.g. 0.55555 is allowed but .55555 is not).
+- check line endings to make sure they are Unix and not DOS
+- check strain headers against a source of truth (see strains.csv)
-- 
cgit v1.2.3