PlotCorrelationScatterplot: Plot scatter plot for correlation between two vectors....

View source: R/CreateSynSBS1SB5Correlated.R

PlotCorrelationScatterplotR Documentation

Plot scatter plot for correlation between two vectors. PlotCorrelationScatterplot is a wrapper around graphics::plot(), and a function to plot the correlation between two vectors, x and y. These vectors are expected to be exposures of two signatures. It will draw a scatterplot, and it will also print information onto the plot, including correlation between x and y, mean and stdev of x and y, etc.

Description

Plot scatter plot for correlation between two vectors.

PlotCorrelationScatterplot is a wrapper around graphics::plot(), and a function to plot the correlation between two vectors, x and y. These vectors are expected to be exposures of two signatures.

It will draw a scatterplot, and it will also print information onto the plot, including correlation between x and y, mean and stdev of x and y, etc.

Usage

PlotCorrelationScatterplot(
  x,
  y,
  xlab = NULL,
  ylab = NULL,
  main = NULL,
  optional.remarks = "",
  ...
)

Arguments

x

vector of exposures of main.signature (SBS5 in the paper). The exposures of main.siganture will be aligned onto x axis.

y

vector of exposures of correlated.signature (SBS1 in the paper). The exposures of correlated.siganture will be aligned onto y axis.

xlab

Label below x axis.

ylab

Label below y axis.

main

Title on the scatterplot. Default: NULL

optional.remarks

Remarks added below the title.

...

Other parameters provided to the function graphics::plot().


steverozen/SynSigGen documentation built on April 1, 2022, 8:54 p.m.