buildAllPlotsForGene {JunctionSeq} | R Documentation

## Create and save one or more JunctionSeq expression plots.

### Description

Generates and saves one or more plots, displaying counts or averages for all counting bins across one particular gene. The parameters `expr.plot`, `normCounts.plot`, `rExpr.plot`, and `rawCounts.plot` determine which plot types are to be generated, and the parameters `with.TX` and `without.TX` determines whether these plots should include or not include the full transcript information, or if separate plots should be generated with and without the full transcript information.

Note that this function has MANY parameters, allowing the user to tweak the behavior and appearance of the plots to suit their particular needs and preferences. Don't be daunted: the default parameters are probably fine for most purposes.

### Usage

    buildAllPlotsForGene(geneID, jscs,
         outfile.prefix = "./",
         use.plotting.device = c("png","CairoPNG","svg",
                                 "tiff","cairo_ps","custom"),
         sequencing.type = c("paired-end","single-end"),
         use.vst=FALSE, use.log = TRUE,
         exon.rescale.factor = 0.3,
         with.TX=TRUE,without.TX=TRUE,
         expr.plot=TRUE,normCounts.plot=TRUE,
         rExpr.plot=TRUE,rawCounts.plot=FALSE,
         colorRed.FDR.threshold = 0.01,
         colorList=list(),
         plot.gene.level.expression = TRUE,
         plot.exon.results, plot.junction.results, plot.novel.junction.results,
         plot.untestable.results = FALSE,
         plot.lwd=3, axes.lwd = plot.lwd, anno.lwd = plot.lwd,
         gene.lwd = plot.lwd / 2,
         par.cex = 1, name.files.with.geneID = TRUE,
         anno.cex.text = 1,
         anno.cex.axis = anno.cex.text, anno.cex.main = anno.cex.text * 1.2,
         drawCoordinates = TRUE,
         yAxisLabels.inExponentialForm = FALSE,
         show.strand.arrows = 1,
         graph.margins = c(2, 3, 3, 3),
         base.plot.height = 12, base.plot.width = 12,
         base.plot.units = "in",
         GENE.annotation.relative.height = 0.15,
         TX.annotation.relative.height = 0.05,
         CONNECTIONS.relative.height = 0.1,
         SPLICE.annotation.relative.height = 0.1,
         TX.margins = c(0,0.5),
         autoscale.height.to.fit.TX.annotation = TRUE,
         autoscale.width.to.fit.bins = 35,
         plotting.device.params = list(),
         condition.legend.text, include.TX.names = TRUE,
         draw.start.end.sites = TRUE, draw.nested.SJ = TRUE,
         openPlottingDeviceFunc = NULL, closePlottingDeviceFunc = NULL,
         minimalImageFilenames = FALSE,
         verbose=TRUE, debug.mode = FALSE,
         INTERNAL.VARS=list(),
         ...)

### Arguments

`geneID` | Character string. Which gene to plot.
`jscs` | A `JunctionSeqCountSet`. Usually created by `runJunctionSeqAnalyses`. Alternatively, this can be created manually by `readJunctionSeqCounts`. However in this case a number of additional steps will be necessary: Dispersions and size factors must then be set, usually using functions `estimateSizeFactors` and `estimateJunctionSeqDispersions`. Hypothesis tests must be performed by `testForDiffUsage`. Effect sizes and parameter estimates must be created via `estimateEffectSizes`.
`outfile.prefix` | Character string or vector. Sets the prefix file path where image files should be saved. If the destination directory does not exist then JunctionSeq will automatically create it. If the parent directory does not exist then JunctionSeq will throw an error. Optionally, `outfile.prefix` can be a vector of strings, assigning a different file prefix to each plot. This alternative is primarily intended for internal use by `buildAllPlots`.
`use.plotting.device` | The plotting device to use.
`sequencing.type` | The type of sequencing used, either "paired-end" or "single-end". This only affects the labelling of the y-axis, and does not affect the actual plots in any way.
`use.vst` | Logical. If `TRUE`, all plots will be scaled via a variance stabilizing transform.
`use.log` | Logical. If `TRUE`, all plots will be log-scaled.
`exon.rescale.factor` | Numeric. Exons will be proportionately scaled-up so that the exonic regions make up this fraction of the horizontal plotting area. If negative, exons and introns will be plotted to a common scale.
`with.TX` | if `TRUE`, save expression plots with the full transcripts printed
`without.TX` | if `TRUE`, save expression plots with only the compiled exons printed. Note that if this and with.TX.plot are both TRUE, both versions will be saved seperately.
`expr.plot` | if `TRUE`, save an expression plot of the expression parameter estimates for each splice site, for each condition.
`normCounts.plot` | if `TRUE`, save an expression plot of the normalized mean counts for each splice site, for each sample.
`rExpr.plot` | if `TRUE`, save an expression plot of the expression parameter estimates, relative to gene-wide expression, for each splice site, for each condition.
`rawCounts.plot` | if `TRUE`, save an expression plot of the raw counts for each splice site, for each sample. Note that these will never be VST-transformed, even when use.vst == TRUE.
`colorRed.FDR.threshold` | The adjusted-p-value threshold used to determine whether a feature should be marked as "significant" and colored pink. By default this will be the same as the FDR.threshold.
`colorList` | A named list of R colors, setting the colors used for various things. See `plotJunctionSeqResultsForGene`
`plot.gene.level.expression` | Logical value. If `TRUE`, gene-level expression (when applicable) will be plotted beside the sub-element-specific expression in a small seperate plotting box. For the "relative expression" plots the simple mean normalized expression will be plotted (since it doesn't make sense to plot something relative to itself).
`plot.exon.results` | Logical. If `TRUE`, plot results for exons. By default everything that was tested will be plotted.
`plot.junction.results` | Logical. If `TRUE`, plot results for splice junctions. By default everything that was tested will be plotted.
`plot.novel.junction.results` | Logical. If `TRUE`, plot results for novel splice junctions. If false, novel splice junctions will be ignored. By default everything that was tested will be plotted.
`plot.untestable.results` | Logical. If `TRUE`, plots splice junctions that had coverage that was too low to be tested.
`plot.lwd` | the line width for the plotting lines.
`axes.lwd` | the line width for the axes.
`anno.lwd` | the line width for the various other annotation lines.
`gene.lwd` | the line width used for the gene annotation lines.
`par.cex` | The base cex value to be passed to par() immediately before all plots are created. See `par`.
`name.files.with.geneID` | Whether to use the geneID (rather than gene name) for naming the files.
`anno.cex.text` | The font size multiplier for most annotation text. This will be multiplied by a factor of the par.cex value. More specifically: The cex value to be passed to all function calls that take graphical parameters. See `par`.
`anno.cex.axis` | The font size multiplier for the axis text. This will be multiplied by a factor of the par.cex value. More specifically: The cex.axis value to be passed to all function calls that take graphical parameters. See `par`.
`anno.cex.main` | The font size multiplier for the main title text. This will be multiplied by a factor of the par.cex value. More specifically: The cex.main value to be passed to all function calls that take graphical parameters. See `par`.
`drawCoordinates` | Whether to label the genomic coordinates at the bottom of the plot.
`yAxisLabels.inExponentialForm` | Logical. If `TRUE`, then the y-axis will be labelled in exponential form.
`show.strand.arrows` | The number of strand-direction arrows to display. If equal to `1` (the default) then the arrow will extend from the end of the gene drawing, if it is greater than `1` then arrows will be drawn along the gene length. If it is `0` or `NA` then arrows will not be drawn.
`graph.margins` | Numeric vector of length 4. These margins values used (as if for par("mar")) for the main graph. The lower part of the plot uses the same left and right margins.
`base.plot.height` | The base height of the standard-sized plots. Plots that include the full transcript annotation will be expanded by the height of these additional rows. See the withTxPlot.height.multiplier parameter, below.
`base.plot.width` | The base width of the plots (plots with a large number of features may be scaled up, see parameter `autoscale.width.to.fit.bins`).
`base.plot.units` | The units of measurement for the plot height and width. Default is px, or pixels.
`GENE.annotation.relative.height` | The height of the "gene track" displayed underneath the main graph, relative to the height of the main graph. By default it is 20 percent.
`TX.annotation.relative.height` | For all plots that draw the annotated-transcript set (when the `with.TX` parameter is `TRUE`), this sets the height of each transcript, as a fraction of the height of the main graph. By default it is 2.5 percent.
`CONNECTIONS.relative.height` | The height of the panel that connects the plotting area to the gene annotation area, relative to the height of the plotting area. This panel has the lines that connects the counting bin columns to their actual loci on the gene. By default it is 10 percent.
`SPLICE.annotation.relative.height` | The height of the area that shows the splice junction loci, relative to the size of the plotting area.
`TX.margins` | A numeric vector of length 2. The size of the blank space between the gene plot and the transcript list and then beneath the transcript list, relative to the size of each transcript line.
`autoscale.height.to.fit.TX.annotation` | Plots that include the full transcript annotation generally need to have a larger height in order to maintain readability. By default, all plots that include transcripts will be expanded vertically by the height of the additional transcripts. This maintains the same appearance and aspect ratio of the main graph, but also means that the height of the plot will differ between genes. This parameter can be used to override that behavior if a specific figure size is desired. If `TRUE`, the `base.plot.height` will be used as the height of the plot, regardless of how many transcripts are included.
`autoscale.width.to.fit.bins` | Integer value. JunctionSeq will automatically go to great lengths to autofit the data in a readable way. By default, any plots that have more than 35 plotting columns will be widened linearly to fit the excess columns. This parameter can be used to change that value, or turn it off entirely by setting this parameter to `NA`.
`plotting.device.params` | Additional parameters to be passed to the plotting device.
`condition.legend.text` | List or named vector of character strings. This optional parameter can be used to assign labels to each condition variable values. It should be a list or named vector with length equal to `factor(condition)`. Each element should be named with one of the values from `factor(condition)`, and should contain the label. They will be listed in this order in the figure legend.
`include.TX.names` | Logical value. If `TRUE`, then for the plots that include the annotated transcript, the transcript names will be listed. The labels will be drawn at half the size of `anno.cex.text`.
`draw.start.end.sites` | Logical value. If `TRUE`, then transcript start/end sites will be marked on the main gene annotation.
`draw.nested.SJ` | Logical. If `TRUE`, overlapping splice junctions will be drawn layered under one another. This can vastly improve readability when there are a large number of overlapping splice junctions. Default is `TRUE`.
`openPlottingDeviceFunc` | An R function. This option can be used to use plotting devices other than the ones directly supported by JunctionSeq. This must be a function that must have 3 parameters: filename, heightMult, and widthMult. It should open the desired plotting device. For advanced users only.
`closePlottingDeviceFunc` | An R function. This must be used in conjunction with openPlottingDeviceFunc. For most devices, you can just use the function "dev.off". For advanced users only.
`minimalImageFilenames` | Logical. If `TRUE`, then the image files will not include the gene names. By default this is `FALSE`, but may be set to `TRUE` when this function is called internally by `buildAllPlots` using the default options. This option is sometimes needed so that the image files are compatible with certain web hosts that have file name length restrictions.
`verbose` | if `TRUE`, send debugging and progress messages to the console / stdout.
`debug.mode` | if TRUE, send even more debugging and progress messages to the console / stdout.
`INTERNAL.VARS` | NOT FOR GENERAL USE. Intended only for use by JunctionSeq itself, internally. This is used for passing pre-generated data (when generating many similar plots, for example), and for internally-generated parameters. DO NOT USE.
`...` | Additional options to pass to `plotJunctionSeqResultsForGene`, or graphical parameters passed to plotting functions.

### Value

This is a side-effecting function, and does not return a value.

### Examples

    data(exampleDataSet,package="JctSeqData");
    buildAllPlotsForGene(geneID = "ENSRNOG00000009281", jscs);

    ## Not run:
    ########################################
    #Set up example data:
    decoder.file <- system.file(
                      "extdata/annoFiles/decoder.bySample.txt",
                      package="JctSeqData");
    decoder <- read.table(decoder.file,
                      header=TRUE,
                      stringsAsFactors=FALSE);
    gff.file <- system.file(
                "extdata/cts/withNovel.forJunctionSeq.gff.gz",
                package="JctSeqData");
    countFiles <- system.file(paste0("extdata/cts/",
         decoder$sample.ID,
         "/QC.spliceJunctionAndExonCounts.withNovel.forJunctionSeq.txt.gz"),
         package="JctSeqData");
    ########################################
    #Run example analysis:
    jscs <- runJunctionSeqAnalyses(sample.files = countFiles,
               sample.names = decoder$sample.ID,
               condition=factor(decoder$group.ID),
               flat.gff.file = gff.file,
               analysis.type = "junctionsAndExons"
    );
    ########################################

    #Generate several related plots for the selected gene:
    buildAllPlotsForGene(geneID = "ENSRNOG00000009281", jscs);

    ## End(Not run)

[Package JunctionSeq version 1.10.0 Index]