multi_dittoDimPlot {dittoSeq} | R Documentation

## Generates dittoDimPlots for multiple features.

### Description

Generates dittoDimPlots for multiple features.

### Usage

    multi_dittoDimPlot(
      object,
      vars,
      ncol = NULL,
      nrow = NULL,
      axes.labels.show = FALSE,
      list.out = FALSE,
      OUT.List = NULL,
      ...,
      xlab = NA,
      ylab = NA,
      data.out = FALSE,
      do.hover = FALSE,
      legend.show = FALSE
    )

### Arguments

`object` | A Seurat, SingleCellExperiment, or SummarizedExperiment object.
`vars` | c("var1","var2","var3",...). A vector of vars ('var' in regular `dittoDimPlot`) from which to generate the separate plots.
`ncol, nrow` | Integer or NULL. How many columns or rows the plots should be arranged into.
`axes.labels.show` | Logical. Whether axis labels should be shown. Subordinate to `xlab` and `ylab`.
`list.out` | Logical. (Default = FALSE) When set to `TRUE`, a list of the individual plots, named by the `vars` being shown in each, is output instead of the combined multi-plot.
`OUT.List` | Deprecated. Use `list.out`
`..., xlab, ylab, data.out, do.hover, legend.show` | other parameters passed to `dittoDimPlot`.

### Details

Given multiple 'var' parameters to `vars`, this function creates a `dittoDimPlot` for each one, with minor defaulting tweaks (see below).

By default, these dittoDimPlots are arranged into a grid. Alternatively, if `list.out` is set to `TRUE`, they are output as a list with each plot named as the `vars` being shown.

All parameters that can be adjusted in dittoDimPlot can be adjusted here, but the only input that will change between plots is `var`.

### Value

A set of dittoDimPlots either arranged into a grid (default), or output as a list.

### Slight tweaks to dittoDimPlot defaults

- axes labels are not shown by default to save space (control with `axes.labels.show` or `xlab` and `ylab`)

- legends are also not shown to save space (control with `legend.show`)

### Author(s)

Daniel Bunis

### See Also

`multi_dittoDimPlotVaryCells` for an alternate `dittoDimPlot` multi-plotter where the cells/samples are varied between plots.

`dittoDimPlot` for the base dittoDimPlot plotting function and details on all accepted inputs.

### Examples

    example(importDittoBulk, echo = FALSE)

    multi_dittoDimPlot(myRNA, c("gene1", "gene2", "clustering"))

    # Control grid shape with ncol / nrow
    multi_dittoDimPlot(myRNA, c("gene1", "gene2", "clustering"),
        nrow = 1)

    # Output as list instead
    multi_dittoDimPlot(myRNA, c("gene1", "gene2", "clustering"),
        list.out = TRUE)

[Package dittoSeq version 1.2.6 Index]