dot-parseKeyParams: Parse key parameters from an object and format as a string

In vertesy/Seurat.utils: Seurat.utils - utility functions for Seurat

Parse key parameters from an object and format as a string

Description

This function extracts the number of scaled features, the number of principal components, and formats additional information including regression variables.

Usage

.parseKeyParams(
  obj,
  regressionVariables = NULL,
  nrVarFeatures = NULL,
  return.as.name = FALSE,
  assay = Seurat::DefaultAssay(obj),
  suffix = NULL,
  v = TRUE
)

Arguments

obj	An object to extract information from.
regressionVariables	A list or vector containing variables for regression. Default: NULL. If NULL, the function will attempt to extract the variables from the object@commands$ScaleData.
nrVarFeatures	You can provide this number manually. Default: NULL.
return.as.name	If TRUE, returns the name of the object. Default: FALSE.
assay	The assay to extract scaled features from. Default: "RNA".
suffix	A suffix string to add.
v	Verbose? Default: TRUE.

Value

A character string summarizing the key parameters.

vertesy/Seurat.utils documentation built on Dec. 4, 2024, 5:20 p.m.