Skip to contents

Contains methods for reading and displaying contents of the bcftools_stats.txt file (QUAL section) output from running bcftools stats.

Super class

dracarys::File -> BcftoolsStatsFile

Methods

Inherited methods


Method read()

Reads the QUAL section from the bcftools_stats.txt file.

Usage

BcftoolsStatsFile$read()

Returns

A tibble.


Method write()

Writes a tidy version of the bcftools_stats.txt (only QUAL section) file output from TSO.

Usage

BcftoolsStatsFile$write(
  d,
  out_dir = NULL,
  prefix,
  out_format = "tsv",
  drid = NULL
)

Arguments

d

Parsed object from self$read().

out_dir

Output directory.

prefix

Prefix of output file(s).

out_format

Format of output file(s).

drid

dracarys ID to use for the dataset (e.g. wfrid.123, prid.456).


Method clone()

The objects of this class are cloneable with this method.

Usage

BcftoolsStatsFile$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
x <- "/path/to/bcftools_stats.txt"
d <- BcftoolsStatsFile$new(x)
d_parsed <- d$read()
d$write(d_parsed, out_dir = tempdir(), prefix = "sample123", out_format = "tsv")
} # }