📝 update docs

README.md

@@ -1,5 +1,9 @@
 # Kids First DRC Joint Genotyping Workflow
-Kids First Data Resource Center Joint Genotyping Workflow (cram-to-deNovoGVCF). Cohort sample variant calling and genotype refinement.
+Kids First Data Resource Center Joint Genotyping Workflow (cram-to-deNovoGVCF). **_Small_** Cohort sample variant calling and genotype refinement.
+This workflow is intended for family cohort calling, typically mother-father-proband trios.
+If you wish to run on a larger cohort, please see our [Kids First-Sentieon Joint Cohort Calling](https://github.com/kids-first/Kids-First-Sentieon-Joint-Cohort-Genotyping-Workflow) workflow.
+Furthermore, in its current state, it follows best practices for WGS input only.
+While WXS data could be run, parameters are not currently optimized for that, but a planned update will allow for appropriate defaults to be set for either input type.
 Note: The DNA annotation has been significantly upgraded since v2.2.3, if you'd like to use the old version, revert to that release.
 
 Using existing gVCFs, likely from GATK Haplotype Caller, we follow this workflow: [Germline short variant discovery (SNPs + Indels)](https://gatk.broadinstitute.org/hc/en-us/articles/360035535932-Germline-short-variant-discovery-SNPs-Indels), to create family joint calling and joint trios (typically mother-father-child) variant calls. Peddy is run to raise any potential issues in family relation definitions and sex assignment.
@@ -45,6 +49,15 @@ This workflow is the current production workflow, equivalent to this [CAVATICA p
     - CADDv1.6-38-whole_genome_SNVs.tsv.gz
     - clinvar_20220507_chr.vcf.gz
 
+## Outputs
+Note: Not all outputs are available from the Kids First Portal. If there is an output that you'd like that is produced by the workflow that is not available, please contact support@kidsfirstdrc.org.
+ - `collectvariantcallingmetrics`: Variant calling summary and detailed metrics files
+ - `peddy_html`: html summary of peddy results
+ - `peddy_ped`: ped format summary of peddy results
+ - `cgp_vep_annotated_vcf`: Variant Effect Predictor annotated VCF files. File suffix tyically `.multi.vqsr.filtered.denovo.vep_105.vcf.gz`. Contains joint calls with the following:
+   - `lowGQ` FILTER `GQ < 20.0`.
+   - Genotype posterior probabilities. See [here](https://gatk.broadinstitute.org/hc/en-us/articles/360037226592-CalculateGenotypePosteriors) for an explanation
+   - INFO tags of `hiConfDeNovo`, `loConfDeNovo`. See [here](https://gatk.broadinstitute.org/hc/en-us/articles/4409924802331-PossibleDeNovo) for more info
 
 ## Import info on cloning the git repo
 This repo takes advantage of the git submodule feature.

workflow/kfdrc-jointgenotyping-refinement-workflow.cwl

@@ -4,10 +4,14 @@ id: kfdrc-jointgenotyping-refinement-workflow
 label: Kids First DRC Joint Genotyping Workflow
 doc: |
   # Kids First DRC Joint Genotyping Workflow
-  Kids First Data Resource Center Joint Genotyping Workflow (cram-to-deNovoGVCF). Cohort sample variant calling and genotype refinement.
+  Kids First Data Resource Center Joint Genotyping Workflow (cram-to-deNovoGVCF). **_Small_** Cohort sample variant calling and genotype refinement.
+  This workflow is intended for family cohort calling, typically mother-father-proband trios.
+  If you wish to run on a larger cohort, please see our [Kids First-Sentieon Joint Cohort Calling](https://github.com/kids-first/Kids-First-Sentieon-Joint-Cohort-Genotyping-Workflow) workflow.
+  Furthermore, in its current state, it follows best practices for WGS input only.
+  While WXS data could be run, parameters are not currently optimized for that, but a planned update will allow for appropriate defaults to be set for either input type.
   Note: The DNA annotation has been significantly upgraded since v2.2.3, if you'd like to use the old version, revert to that release.
 
-  Using existing gVCFs, likely from GATK Haplotype Caller, we follow this workflow: [Germline short variant discovery (SNPs + Indels)](https://software.broadinstitute.org/gatk/best-practices/workflow?id=11145), to create family joint calling and joint trios (typically mother-father-child) variant calls. Peddy is run to raise any potential issues in family relation definitions and sex assignment.
+  Using existing gVCFs, likely from GATK Haplotype Caller, we follow this workflow: [Germline short variant discovery (SNPs + Indels)](https://gatk.broadinstitute.org/hc/en-us/articles/360035535932-Germline-short-variant-discovery-SNPs-Indels), to create family joint calling and joint trios (typically mother-father-child) variant calls. Peddy is run to raise any potential issues in family relation definitions and sex assignment.
 
   If you would like to run this workflow using the CAVATICA public app, a basic primer on running public apps can be found [here](https://www.notion.so/d3b/Starting-From-Scratch-Running-Cavatica-af5ebb78c38a4f3190e32e67b4ce12bb).
   Alternatively, if you'd like to run it locally using `cwltool`, a basic primer on that can be found [here](https://www.notion.so/d3b/Starting-From-Scratch-Running-CWLtool-b8dbbde2dc7742e4aff290b0a878344d) and combined with app-specific info from the readme below.
@@ -21,7 +25,7 @@ doc: |
   ### Tips To Run:
   1. inputs vcf files are the gVCF files from GATK Haplotype Caller, need to have the index **.tbi** files copy to the same project too.
   1. If you are experiencing issues with Variant Recalibration either in VariantRecalibrator or ApplyVQSR, consider adjusting the max_gaussians. If a dataset gives fewer variants than the expected scale, the number of Gaussians for training should be turned down. Lowering the max-Gaussians forces the program to group variants into a smaller number of clusters, which results in more variants per cluster.
-  1. ped file in the input shows the family relationship between samples, the format should be the same as in GATK website [link](https://gatkforums.broadinstitute.org/gatk/discussion/7696/pedigree-ped-files), the Individual ID, Paternal ID and Maternal ID must be the same as in the inputs vcf files header.
+  1. ped file in the input shows the family relationship between samples, the format should be the same as in GATK website [link](https://gatk.broadinstitute.org/hc/en-us/articles/360035531972-PED-Pedigree-format), the Individual ID, Paternal ID and Maternal ID must be the same as in the inputs vcf files header.
   1. Here we recommend to use GRCh38 as reference genome to do the analysis, positions in gVCF should be GRCh38 too.
   1. Reference locations:
       - Broad Institute Goolge Cloud: https://console.cloud.google.com/storage/browser/gcp-public-data--broad-references/hg38/v0
@@ -50,6 +54,15 @@ doc: |
       - CADDv1.6-38-whole_genome_SNVs.tsv.gz
       - clinvar_20220507_chr.vcf.gz
 
+  ## Outputs
+  Note: Not all outputs are available from the Kids First Portal. If there is an output that you'd like that is produced by the workflow that is not available, please contact support@kidsfirstdrc.org.
+   - `collectvariantcallingmetrics`: Variant calling summary and detailed metrics files
+   - `peddy_html`: html summary of peddy results
+   - `peddy_ped`: ped format summary of peddy results
+   - `cgp_vep_annotated_vcf`: Variant Effect Predictor annotated VCF files. File suffix tyically `.multi.vqsr.filtered.denovo.vep_105.vcf.gz` .Contains joint calls with the following:
+     - `lowGQ` FILTER `GQ < 20.0`.
+     - Genotype posterior probabilities. See [here](https://gatk.broadinstitute.org/hc/en-us/articles/360037226592-CalculateGenotypePosteriors) for an explanation
+     - INFO tags of `hiConfDeNovo`, `loConfDeNovo`. See [here](https://gatk.broadinstitute.org/hc/en-us/articles/4409924802331-PossibleDeNovo) for more info
 
   ## Import info on cloning the git repo
   This repo takes advantage of the git submodule feature.
@@ -379,5 +392,5 @@ hints:
 - VCF
 - VEP
 "sbg:links":
-- id: 'https://github.com/kids-first/kf-jointgenotyping-workflow/releases/tag/v2.4.0'
+- id: 'https://github.com/kids-first/kf-jointgenotyping-workflow/releases/tag/v2.4.1'
   label: github-release