VariantFiltering (version 1.8.6)

autosomalRecessiveHomozygous: Autosomal recessive inheritance analysis: Homozygous

Description

This function works analyzing the variants of the unaffected individuals storing the common heterozygous ones and comparing them with the common homozygous variants between the affected subjects.

Usage

"autosomalRecessiveHomozygous"(param, svparam=ScanVcfParam(), use=c("everything", "complete.obs", "all.obs"), BPPARAM=bpparam("SerialParam"))

Arguments

param

A VariantFilteringParam object built from a multisample VCF file with at least one affected individual and zero or more unaffected ones, and from a PED file specyfing the family relationships among individuals as well as their gender and phenotype status (affected or unaffected).

svparam

An instance of a ScanVcfParam object to enable analyzing a subset of variants and samples. This object is passed internally to a call to the readVcf() function in the VariantAnnotation package, see its help page for a complete description of this functionality.

use

character string specifying the policy to apply on missing genotypes when comparing them. This policy can be either '"everything"' (default), '"complete.obs"' or '"all.obs"'. The default policy ('"everything"') will propagate NA truth values using the behavior of the R logical operators, with the exception that when the final truth value associated with a variant is NA, the variant is ultimately discarded.

BPPARAM

An VariantFilteringParam object containing VCF file(s). From 1 to 5 independent files for affected individuals and 0 to 5 more for unaffected ones (up to 10 individuals). If the VCF is a multi-sample, it can contain the same amount of individuals divided likewise.

Value

An object of class VariantFilteringResults including functional annotations on all selected variants.

Details

This function requires as an input a VariantFilteringParam class object built from an input multisample VCF file, along with a PED file.

References

Elurbe D.M., Mila, M., Castelo, R. The VariantFiltering package, in preparation.

See Also

autosomalRecessiveHeterozygous autosomalDominant xLinked deNovo unrelatedIndividuals VariantFilteringResults

Examples

## Not run: 
# library(VariantFiltering)
# 
# CEUvcf <- file.path(system.file("extdata", package="VariantFiltering"),
#                     "CEUtrio.vcf.bgz")
# CEUped <- file.path(system.file("extdata", package="VariantFiltering"),
#                     "CEUtrio.ped")
# param <- VariantFilteringParam(vcfFilenames=CEUvcf, pedFilename=CEUped)
# reHo <- autosomalRecessiveHomozygous(param)
# reHo
# ## End(Not run)