transcriptWindow1: Meta coverage over all transcripts

View source: R/experiment_plots.R

transcriptWindow1R Documentation

Meta coverage over all transcripts

Description

Given as single window

Usage

transcriptWindow1(
  df,
  outdir = NULL,
  scores = c("sum", "zscore"),
  colors = experiment.colors(df),
  title = "Coverage metaplot",
  windowSize = 100,
  returnPlot = is.null(outdir),
  dfr = NULL,
  idName = "",
  plot.ext = ".pdf",
  type = "ofst",
  drop.zero.dt = drop.zero.dt,
  BPPARAM = bpparam()
)

Arguments

df

an ORFik experiment

outdir

directory to save to (default: NULL, no saving)

scores

scoring function (default: c("sum", "transcriptNormalized")), see ?coverageScorings for possible scores.

colors

Which colors to use, default auto color from function experiment.colors, new color per library type. Else assign colors yourself.

title

title of ggplot

windowSize

size of binned windows, default: 100

returnPlot

return plot from function, default is.null(outdir), so TRUE if outdir is not defined.

dfr

an ORFik experiment of RNA-seq to normalize against. Will add RNA normalized to plot name if this is done.

idName

A character ID to add to saved name of plot, if you make several plots in the same folder, and same experiment, like splitting transcripts in two groups like targets / nontargets etc. (default: "")

plot.ext

character, default: ".pdf". Alternatives: ".png" or ".jpg".

type

a character(default: "ofst"), load files in experiment or some precomputed variant, either "ofst", "pshifted" or "default". These are made with ORFik:::simpleLibs(), shiftFootprintsByExperiment().. Will load default if bedoc is not found

drop.zero.dt

logical FALSE, if TRUE and as.data.table is TRUE, remove all 0 count positions. This greatly speeds up and most importantly, greatly reduces memory usage. Will not change any plots, unless 0 positions are used in some sense. (mean, median, zscore coverage will only scale differently)

BPPARAM

how many cores/threads to use? default: bpparam()

Value

NULL, or ggplot object if returnPlot is TRUE

See Also

Other experiment plots: transcriptWindow(), transcriptWindowPer()


Roleren/ORFik documentation built on April 25, 2024, 8:41 p.m.