annnotateWithControlDepth: Annotate Case with Control Depth

Description Usage Arguments Details Value Author(s) See Also Examples

Description

Matches the case variants to the (typically unfiltered) control variants and returns case, with the additional metadata columns control.alt.depth and control.total.depth, corresponding to altDepth(control) and totalDepth(control), respectively.

Usage

1
annotateWithControlDepth(case, control, control.cov)

Arguments

case

The variants of interest, as a VRanges.

control

The control variants, typically unfiltered, as a VRanges.

control.cov

The control coverage, as an RleList.

Details

If a case variant is not found in control, a count of 0 is assigned to control.alt.depth, under the assumption that the control object is not filtered, i.e., it contains the raw tallies.

Value

case, plus two new metadata columns, control.alt.depth and control.total.depth

Author(s)

Michael Lawrence

See Also

callSampleSpecificVariants, which uses this function.

Examples

1
2
3
4
5
6
7
8
  bams <- LungCancerLines::LungCancerBamFiles()
  tally.param <- TallyVariantsParam(gmapR::TP53Genome(), 
                                    high_base_quality = 23L,
                                    which = gmapR::TP53Which())
  case <- callVariants(bams$H1993, tally.param)
  control <- tallyVariants(bams$H2073, tally.param)
  control.cov <- coverage(bams$H2073)
  annotateWithControlDepth(case, control, control.cov)


Search within the VariantTools package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.