Merge pull request #296 from cidgoh/example-data-0-15-4

example data for 0.15.4 release

Author: ddooley

README.md

@@ -57,6 +57,24 @@ You can also automatically fill a column with a specified value, but only in row
 
 For _more information_ on available application features, select the **Help** button followed by **Getting Started** from within the DataHarmonizer application.
 
+## Example Data
+
+Templates with example data testing functionalities can be found within the following folder structure when available:
+
+```
+. TOP LEVEL DIRECTORY
+├── images
+├── libraries
+├── script
+└── template
+│   ├── templateOfInterest
+│   │   └── exampleInput
+│   └── ...
+```
+
+Alternatively, you can find links to all available test data below:
+- [`canada_covid19`](https://github.com/cidgoh/DataHarmonizer/tree/master/template/canada_covid19/exampleInput) CanCOGeN Covid-19
+
 ## Additional Information
 
 For more information about the DataHarmonizer, it's templates, and how to use them, check out the [DataHarmonizer Wiki](https://github.com/Public-Health-Bioinformatics/DataHarmonizer/wiki).

images/invalid/invalidData_sampleCollectionDate.png

@@ -0,0 +1,22 @@
+# CanCOGeN Example Input Data
+This directory contains example input/test data for the Canadian COVID Genomics Network (CanCOGeN) DataHarmonizer application template: `CanCOGeN Covid-19`. This data is appropriate for testing up to the version appended to the end of the file name, for example:
+
+- `validTestData_0-15-4.csv` is _valid_ for version `0.15.4` of the DataHarmonizer.
+
+## Valid Test Data
+
+Demonstrates _valid_ example input, from controlled vocabulary and date formats to free text strings, for all minimal metadata fields and some recommended/enhanced metadata fields.
+
+## Invalid Test Data
+
+Demonstrates _invalid_ example input, from controlled vocabulary and date formats, for all minimal metadata fields and some recommended/enhanced metadata fields. After validating, empty cells that require input appear dark red while invalid cell contents appear light red.
+
+There are special validation rules for some fields, for example:
+
+- There cannot be duplicates of the database identifier `specimen collector sample ID` field. When duplicates occur the corresponding cells will be flagged light red:
+
+> ![invalidData_specimenCollectorSampleID.png](/images/invalid/invalidData_specimenCollectorSampleID.png?raw=true)
+
+- Sample collection date cannot be before SARS-CoV-2 sampling began even when formatted using the appropriate ISO 8601 standard format "YYYY-MM-DD":
+
+ > ![invalidData_sampleCollectionDate.png](/images/invalid/invalidData_sampleCollectionDate.png?raw=true)