20461 Updating README.md 20461-updating-tiling
authorAlex Coleman <alex.coleman@curii.com>
Thu, 14 Sep 2023 17:14:59 +0000 (11:14 -0600)
committerAlex Coleman <alex.coleman@curii.com>
Thu, 14 Sep 2023 18:00:08 +0000 (12:00 -0600)
Fixing typos, and adding information about building docker images.

Arvados-DCO-1.1-Signed-off-by: Alex Coleman <alex.coleman@curii.com>

cwl/lightning/README.md

index ad484202b8ef8446aeefb5a3a2a494dda65be504..427dede48d416340c14b3fba8b6d8942a3b669fd 100644 (file)
@@ -24,7 +24,7 @@ For examples of input yml files, see `yml/fasta2numpy-wf-100test.yml` and `yml/f
 The tiling workflow has many different inputs, some (like **fastadirs**) vary depending on your run, while others remain more constant (like **dbsnp**)
 
 - **fastadirs** - an array of fasta directories, in our implementation, each directory consists of around 100 fasta pairs.
-- **refdir** - cirectory containing reference FASTAs.
+- **refdir** - directory containing reference FASTAs.
 
 The list of tags is needed to perform tiling
 - **tagset** - List of tags. Found here: c37923fd267415556962d5c535e9b075+110/tagset.fa.gz
@@ -60,4 +60,18 @@ Some publicily accessible data is needed to run the workflows:
 
 - **snpeffdatadir** - Directory of SNP data download. Current data download can be found here: 66c966928931de252274772c76f73025+52054
 - **dbsnp** - SNP database. A single file. Current database can be found here: a088b297d614e4c63cbb23f8ad404438+12313/00-All.vcf.gz_renamed.bcf
-- **gnomaddir** - gnomAD data. Current data can be found here: c6a8fc877e85d73ac5b165e2d7367e26+675135
\ No newline at end of file
+- **gnomaddir** - gnomAD data. Current data can be found here: c6a8fc877e85d73ac5b165e2d7367e26+675135
+
+## Outputs
+
+All outputs will be documented in the README.md that is generated. 
+
+## Building Docker images
+Several docker images are needed to run the tiling workflow. 
+
+All can be found under .../..docker
+
+The images neede to be build are
+
+1)  `lightning` - this can be built
+2)  `vcfutil` - this can be built
\ No newline at end of file