plot_FRmatch_cell2cluster: Plotting function for FR-Match cell2cluster results

View source: R/plot_FRmatch_cell2cluster.R

plot_FRmatch_cell2clusterR Documentation

Plotting function for FR-Match cell2cluster results

Description

This function takes in the FRmatch_cell2cluster output and generates plots for the matching results.

Usage

plot_FRmatch_cell2cluster(
  rst.cell2cluster,
  type = "match",
  p.adj.method = "BH",
  sig.level = 0.1,
  reorder = TRUE,
  return.value = FALSE,
  main = NULL,
  filename = NA,
  width = NULL,
  height = NULL
)

Arguments

rst.cell2cluster

The FRmatch_cell2cluster output.

type

If type="match" (default), it plots the proportion of cells in the query cluster matched to the reference cluster. If type=="padj", it plots the distribution of adjusted p-values.

p.adj.method

P-value adjustment method for multiple hypothesis testing correction. Default: "BH". For more options, please see p.adjust.methods.

sig.level

Numeric variable that specifies the significance level of adjusted p-value. A MATCH is >sig.level. Default: 0.1.

reorder

Boolean variable indicating if to reorder the columns so that matches are aligned along the diagonal. It improves the interpretability of the one-way match plot. Default: TRUE.

return.value

Boolean variable indicating if to return the plotted values. Default: FALSE.

filename, width, height

Plotting parameters passed to ggsave.

Value

If return.value = TRUE, a matrix of plotted.values, and pmat.adj and cell2cluster.adj after adjustment.


JCVenterInstitute/FRmatch documentation built on Dec. 15, 2022, 2:30 p.m.