unrelatedIndividuals: Analysis designed to be applied over a group of unrelated...

In rcastelo/VariantFiltering: Filtering of coding and non-coding genetic variants

Analysis designed to be applied over a group of unrelated individuals

Description

This function is designed to create an object to deepen into the variants presented by a group of unrelated individuals

Usage

## S4 method for signature 'VariantFilteringParam'
unrelatedIndividuals(param,
                                                       svparam=ScanVcfParam(),
                                                       BPPARAM=bpparam("SerialParam"))

Arguments

param	A VariantFilteringParam object built from a multisample VCF file.
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.
BPPARAM	An object of class BiocParallelParam specifiying parameters related to the parallel execution of some of the tasks and calculations within this function. See function bpparam() from the BiocParallel package.

Details

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

Value

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

Author(s)

Dei M. Elurbe and R. Castelo

References

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

See Also

autosomalRecessiveHomozygous autosomalRecessiveHeterozygous autosomalDominant deNovo xLinked VariantFilteringResults

Examples

## Not run: 

CEUvcf <- file.path(system.file("extdata", package="VariantFiltering"), "CEUtrio.vcf.bgz")
param <- VariantFilteringParam(vcfFilename=CEUvcf)
uInd <- unrelatedIndividuals(param)
uInd

## End(Not run)

rcastelo/VariantFiltering documentation built on Oct. 23, 2024, 5:23 p.m.