plot_data_overview: Overview of the input data

View source: R/plot_data.R

plot_data_overviewR Documentation

Overview of the input data

Description

Function to do a tile plot showing the missing value structure of the input data

Usage

plot_data_overview(
  object,
  covariate = 1,
  colors = NULL,
  show_covariate = FALSE,
  show_dimensions = TRUE
)

Arguments

object

a MOFA object.

covariate

(only for MEFISTO) specifies sample covariate to order samples by in the plot. This should be a character or a numeric index giving the name or position of a column present in the covariates slot of the object. Default is the first sample covariate in covariates slot. NULL does not order by covariate

colors

a vector specifying the colors per view (see example for details).

show_covariate

(only for MEFISTO) boolean specifying whether to include the covariate in the plot

show_dimensions

logical indicating whether to plot the dimensions of the data (default is TRUE).

Details

This function is helpful to get an overview of the structure of the data. It shows the model dimensionalities (number of samples, groups, views and features) and it indicates which measurements are missing.

Value

A ggplot object

Examples

# Using an existing trained model
file <- system.file("extdata", "model.hdf5", package = "MOFA2")
model <- load_model(file)
plot_data_overview(model)

bioFAM/MOFA2 documentation built on Feb. 1, 2024, 6:41 a.m.