Skip to content

Commit 5ebe5fc

Browse files
migbroyuankunzhu
authored andcommitted
📖 add secondary file note
1 parent c43ca51 commit 5ebe5fc

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

readme.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ this can be used later on for further analysis in joint trio genotyping and subs
2626
## Inputs:
2727
```yaml
2828
input_bam: input.bam
29-
reference_fasta: Homo_sapiens_assembly38.fasta
29+
reference_fasta: Homo_sapiens_assembly38.fasta # For proper bwa functionality, you also need to copy over all bwa index files related to this reference, with suffixes .alt, .amb, .ann, .bwt, .pac, .sa. These are known as "secondary files" in cwl.
3030
reference_fai: Homo_sapiens_assembly38.fai
3131
reference_dict: Homo_sapiens_assembly38.dict
32-
bwa_index_tar: Homo_sapiens_assembly38.fasta.bwa-0.7.17.tar # tar ball with genome fasta file and all bwa index files
3332
knownsites:
3433
- 1000G_omni2.5.hg38.vcf.gz
3534
- 1000G_phase1.snps.high_confidence.hg38.vcf.gz
@@ -47,4 +46,6 @@ this can be used later on for further analysis in joint trio genotyping and subs
4746
- [sequence_grouping_tsv](examples/sequence_grouping.txt), generated by `bin/CreateSequenceGroupingTSV.py`
4847
- [example-inputs.json](examples/example-inputs.json)
4948

49+
Note, for all vcf files, indexing may be required - a "secondary file" requirement.
50+
5051
![WF Visualized](./kfdrc_alignment_wf.png?raw=true "Workflow diagram")

0 commit comments

Comments
 (0)