create_scCombinedMeta: Create Single-Cell Metadata Object for a collection of Seurat...

View source: R/Seurat.Utils.R

create_scCombinedMetaR Documentation

Create Single-Cell Metadata Object for a collection of Seurat Objects

Description

This function creates a metadata object to correspond to a list of single-cell experiments, for storing parent level information. It initializes the object with the experiment and project name, and the creation date. The created object is of class 'scMetadata_class'.

Usage

create_scCombinedMeta(experiment, project_ = getProject())

Arguments

experiment

The name of the experiment for which metadata is being created.

project_

The project information to be associated with the metadata object. This defaults to the current project obtained using Seurat.utils::getProject().

Value

An 'scCollectionMetadata_class' object containing the metadata for a collection of experiment.

Examples

sc_meta <- create_scCombinedMeta(experiment = "Experiment1")

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