PlotVCFStatsHistograms: PlotVCFStatsHistograms

In cgab-ncc/FIREVAT: FIREVAT, FInding REliable Variants without ArTifacts

PlotVCFStatsHistograms

Description

Plots multiple VCF stats histograms into one figure

Usage

PlotVCFStatsHistograms(
  plot.values,
  x.axis.labels,
  stat.y.max.vals,
  stat.x.max.vals,
  sample.id,
  save.file,
  title,
  cutoff.values,
  plot.boxplot = F,
  plot.cutoff.line.color = "#D4012E",
  plot.cutoff.value.lines = F,
  bin.width = 1,
  ncol = 4,
  nrow = 3,
  font.size.med = 10,
  font.size.large = 12,
  plot.margin = unit(c(0.5, 0.5, 0.5, 0.5), "cm")
)

Arguments

plot.values	A list of multiple numeric vectors
x.axis.labels	A character vector of x axis labels
stat.y.max.vals	A numeric vector of max y-axis values
stat.x.max.vals	A numeric vector of max x-axis values
sample.id	A string value of sample ID
save.file	A string value of file to which the resulting plot will be saved
title	A string value of plot title
cutoff.values	A numeric vector of cutoff values
plot.boxplot	A boolean value (default = False)
plot.cutoff.line.color	A hex string value (default = "#D4012E")
plot.cutoff.value.lines	A boolean value (default = False)
bin.width	An integer value (default = 1; histogram bin width)
ncol	An integer value (default = 4; ggarrange ncol)
nrow	An integer value (default = 3; ggarrange nrow)
font.size.med	An integer value (default = 10)
font.size.large	An integer value (default = 12)
plot.margin	A list (default = unit(c(0.5, 0.5, 0.5, 0.5), "cm"))

Value

A list with the following elements

• f = A ggarrange object

• graphs = A list of length 3; each element is a ggplot histogram

cgab-ncc/FIREVAT documentation built on Nov. 19, 2022, 5:55 p.m.