gsa.read.gatkreport: Function to read in a GATKReport

In gsalib: Utility Functions for 'GATK'

Function to read in a GATKReport

Description

This function reads in data from a GATKReport. A GATKReport is a document containing multiple tables produced by the GATK. Each table is loaded as a separate data.frame object in a list.

Usage

gsa.read.gatkreport(filename)

Arguments

filename

The path to the GATKReport file.

Details

The GATKReport format replaces the multi-file output format used previously by many GATK tools and provides a single, consolidated file format. This format accommodates multiple tables and is still R-loadable through this function.

Value

Returns a LIST object, where each key is the TableName and the value is the data.frame object with the contents of the table. If multiple tables with the same name exist, each one after the first will be given names of TableName.v1, TableName.v2, ..., TableName.vN.

Note

This function accepts different versions of the GATKReport format by making internal calls to gsa.read.gatkreportv0() or gsa.read.gatkreportv1() as appropriate.

Author(s)

Kiran Garimella

References

https://gatk.broadinstitute.org/hc/en-us/articles/360035532172-GATKReport-and-gsalib

Examples

test_file = system.file("extdata", "test_gatkreport.table", package = "gsalib");
report = gsa.read.gatkreport(test_file);

gsalib documentation built on Oct. 8, 2022, 1:06 a.m.