This app runs peddy v0.3.1 (https://github.com/brentp/peddy) to perform a run wide QC check that the assigned gender matches the sample.
Peddy detects when the expected sex of a sample does not match the sex inferred from the sequence data. This works by measuring the ratio of heterozygous to homozygous genotypes in the X chromosome; As males have one X chromosome, they should have zero true heterozygous calls in the X chromosome, whereas females should have a mixture. This is reported via the sex/het ratio, which is the count of heterozygous calls divided by the count of homozygous alternate calls. The sex/het ratio is low for males, high for females.
The app should be run after workflows for all samples in a run complete succesfully. The peddy output files are processed by multiqc >v1.3, which displays peddy data in the resulting report. This app is scheduled to run by the DNA Nexus upload agent script using the --depends-on flag.
- A project number is passed to the app as a parameter.
- The given project must have an 'output' folder containing VCFs to be processed by peddy.
- More than one vcf with the extension '.refined.vcf.gz' or 'aplotyper.vcf.gz' is required.
- The filename of each sample must include the gender as 'M' or 'F' deliminated by underscores.
All output files produced are prefixed with 'ped'. MultiQC requires 4 files:
- ped.peddy.ped
- ped.het_check.csv
- ped.ped_check.csv
- ped.sex_check.csv
These files are output to the directory '/QC/'. Files in this directory are included in the final MultiQC report generated by the dnanexus_multiqc app. The remaining peddy output files are placed in the subfolder '/QC/peddy'.
This app performs the following procedure:
- Parse the file names to determine the expected sex for each sample and create a fam file containing this information.
- Download and merge the VCFs in the project's '/output/' folder.
- Run peddy, passing the merged VCF and fam file as arguments.
- Upload outputs to the directories '/QC/' and '/QC/peddy' in the DNA Nexus project.
The project which peddy is run on must be shared with the user mokaguys. An valid authentication token must be present in the project 001_Authentication.