filter_cluster_size: Filter out gene clusters containing few genes

View source: R/filter_gene_clusters.R

filter_cluster_sizeR Documentation

Filter out gene clusters containing few genes

Description

This function filters out gene clusters from a ClusterSet object based on their size.

Usage

filter_cluster_size(object = NULL, min_cluster_size = 5)

Arguments

object

A ClusterSet object.

min_cluster_size

An integer indicating the minimum size for a clusters to be kept.

Value

A ClusterSet object where clusters not passing the filter have been removed.

Examples

# Set verbosity to 1 to display info messages only.
set_verbosity(1)

# Load a dataset
load_example_dataset('7871581/files/pbmc3k_medium_clusters')
clust_size(pbmc3k_medium_clusters)
# Remove the cluster with less than 20 genes
clust_set <- filter_cluster_size(pbmc3k_medium_clusters,
                                 min_cluster_size = 20)
clust_size(clust_set)


dputhier/scigenex documentation built on Jan. 29, 2024, 3:40 p.m.