From 3fb8a4de897eabd3e85520358619af7abcbd7664 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Fri, 23 Dec 2022 08:47:44 +0300
Subject: Help: Provide some help content for end user
---
qc_app/templates/data_review.html | 77 +++++++++++++++++++++++++++++++++++++++
1 file changed, 77 insertions(+)
create mode 100644 qc_app/templates/data_review.html
(limited to 'qc_app/templates/data_review.html')
diff --git a/qc_app/templates/data_review.html b/qc_app/templates/data_review.html
new file mode 100644
index 0000000..7ac01ba
--- /dev/null
+++ b/qc_app/templates/data_review.html
@@ -0,0 +1,77 @@
+{%extends "base.html"%}
+
+{%block title%}Data Review{%endblock%}
+
+{%block contents%}
+
data review
+
+
+
Data Concerns
+
The following are some of the requirements that the data in your file
+ MUST fulfil before it is considered valid for this system:
+
+
+
+ - File headings
+
+ - The first row in the file should contains the headings. The number of
+ headings in this first row determines the number of columns expected for
+ all other lines in the file.
+ - Each heading value in the first row MUST appear in the first row
+ ONE AND ONLY ONE time
+ - The strain headers in your first row will be against a source of truth
+ (see strains.csv [1.7M]).
+ Pick the strain names from the 'Name' and
+ 'Name2' fields.
+
+
+
+ - Data
+
+ - NONE of the data cells/fields is allowed to be empty.
+ All fields/cells MUST contain a value.
+ - The first column of the data rows will be considered a textual field,
+ holding the "identifier" for that row
-
+
- Except for the first column/field for each data row,
+ NONE of the data columns/cells/fields should contain
+ spurious characters like `eeeee`, `5.555iloveguix`, etc...
+ All of them should be decimal values
+ - decimal numbers must conform to the following criteria:
+
+ - when checking an average file decimal numbers must have exactly three
+ decimal places to the right of the decimal point.
+ - when checking a standard error file decimal numbers must have six or
+ greater decimal places to the right of the decimal point.
+ - there must be a number to the left side of the decimal place
+ (e.g. 0.55555 is allowed but .55555 is not).
-
+
+
+
+
+
+
+
+
Supported File Types
+ We support the following file types:
+
+
+ - Tab-Separated value files (.tsv)
+
+ - The TAB character is used to separate the fields of each
+ column
+ - The values of each field ARE NOT quoted.
+ - Here is an
+
+ example file with a single data row.
+
+
+ - .txt files: Content has the same format as .tsv file above
+ - .zip files: each zip file should contain
+ ONE AND ONLY ONE file of the .tsv or .txt type above.
+
Any zip file with more than one file is invalid, and so is an empty
+ zip file.
+
+
+
+{%endblock%}
--
cgit v1.2.3