plotAllelicBiasResultsOverview {SNPhood} | R Documentation

## Visualize the results of the allelic bias analysis across regions or a user-defined genomic range

### Description

`plotBinCounts` visualizes the results of the allelic bias analysis across regions or a user-defined genomic range. Note that only the results of a particular chromosome can be visualized. It is therefore only possible if the regions to be visualized are located on one particular chromosome; otherwise, an error is thrown.

### Usage

    plotAllelicBiasResultsOverview(SNPhood.o, regions = 1, datasets = NULL,
      plotChr = NULL, plotStartPos = NULL, plotEndPos = NULL, ylim = NULL,
      plotRegionBoundaries = FALSE, plotRegionLabels = FALSE,
      signThreshold = 0.05, pValueSummary = "min", maxWidthLabels = NULL,
      colorPalette = "Set1", sizePoints = 4, printPlot = TRUE,
      fileToPlot = NULL, verbose = FALSE)

### Arguments

`SNPhood.o` | Object of class `SNPhood`
`regions` | Numeric or Character or NULL. Default NULL. Regions that should be plotted, either specified as integer (such as 1, value must be between 1 and the total number of regions as defined in the object) or their annotation (name must appear in the region names as obtained via the function `annotationRegions`). If set to NULL, all regions will be considered.
`datasets` | Numeric or Character or NULL. Default NULL. Datasets that should be used for plotting, either specified as integer (such as 1, value must be between 1 and the total number of datasets as defined in the object) or their annotation (name must appear in the dataset names as obtained via the function `annotationDatasets`). If set to NULL, all datasets will be considered.
`plotChr` | Character(1) or NULL. Default NULL. The name of the chromosome for which the visualization should be done. Must be a valid chromosome name. If set to NULL, other parameters (such as`regions`) determine which genomic region should be plotted.
`plotStartPos` | Character(1) or NULL. Default NULL. The start coordinates for which the visualization should be done. Must be a valid number with respect to the chromosome it refers to. If set to NULL and the parameter `plotChr` is not NULL, the start coordinates are set to 1.
`plotEndPos` | Character(1) or NULL. Default NULL. The end coordinates for which the visualization should be done. Must be a valid number with respect to the chromosome it refers to. If set to NULL and the parameter `plotChr` is not NULL, the end coordinates are determined automatically and the full chromosome will be plotted.
`ylim` | Numeric(2). Default NULL. Range of the y-axis, as specified by a minimum and a maximum value. See ?ylim for details.
`plotRegionBoundaries` | Logical(1). Default FALSE. Should the region boundaries be drawn in the plot? If set to TRUE, two vertical lines will be drawn for each region, corresponding to the region boundaries upstream and downstream of the SNP. This visual aid may help to judge the size of the regions and overlaps among regions.
`plotRegionLabels` | Logical(1). Should the annotation of the regions be drawn vertically below the x axis? If many regions are plotted, labels may overlap; however, for a few regions, this is usually not a problem.
`signThreshold` | Numeric(1). Default 0.05. The significance threshold (such as p-value or FDR threshold). Must be between 0 and 1. If the parameter belongs to a plotting function, a horizontal line is drawn at the chosen value. For the allelic bias summary plots, p-values below this threshold and the corresponding allelic fractions are highlighted.
`pValueSummary` | Character(1). Default "min". Either "min" or "median". If set to "min", for each region, the minimum p-value across all bins is displayed as a representative result for the region. This is in analogy to how the background caclulation for the FDR calculation works, see the vignette for details. If set to "median", the median p-value is calculated for each region and plotted. This may facilitate to identify regions for which a lot of bins have low p-values.
`maxWidthLabels` | Numeric(1). Default NULL. Maximum width of the legend labels in number of characters. If the width of the legend labels are longer, they are shortened. Set to NULL to not shorten labels.
`colorPalette` | Character(1). Default "Set1". Name of the palette from the `RColorBrewer` package from the qualitative palettes for the colors of the datasets that are plotted. Allowed palette names are "Accent", "Dark2", "Paired", "Pastel1", "Pastel2", "Set1", "Set2", and "Set3". Colors for the datasets are then determined automatically from the given palette name (from left to right, depending on the number of datasets to be plotted). The colors for the read groups within each datasets are based on the colors for the dataset, but with different saturation values.
`sizePoints` | Numeric(1). Default 4. Size of the points that are drawn in the plot (if type is set to the default value of "p"). This parameter has no effect if type is set to "l".
`printPlot` | Logical(1). Default TRUE. Should the plots be printed? Only relevant if `fileToPlot` is set to NULL; otherwise, the plots are always printed to the output file.
`fileToPlot` | Character(1) or `NULL`. Default `NULL`. Filename of the PDF file for the output plots. If set to `NULL`, plots will be plotted to the currently active device.
`verbose` | Logical(1). Default FALSE. Should the verbose mode (i.e., diagnostic messages during execution of the script) be enabled?

### Value

the generated ggplot2 plot(s) as list for further processing. May contain multiple plots, depending on the function. The plot(s) can then be plotted individually or modified arbitrarily as the user wants. For example, if multiple plots are returned and the plots have been saved in a variable called plots.l, simply type plots.l[[1]] to view the first plot.

### Examples

    data(SNPhood.o, package="SNPhood")

    # Plot the allelic bias results for the first region using default values for all parameters
    plots = plotAllelicBiasResultsOverview(SNPhood.o)

    # Plot the allelic bias results for the full chr21
    plots = plotAllelicBiasResultsOverview(SNPhood.o, regions = NULL, plotChr = "chr21")

[Package SNPhood version 1.18.0 Index]