update_cluster_descriptions_by_cluster_annotation_mapping_df: update_cluster_descriptions_by_cluster_annotation_mapping_df

View source: R/loom.R

update_cluster_descriptions_by_cluster_annotation_mapping_dfR Documentation

update_cluster_descriptions_by_cluster_annotation_mapping_df

Description

Update the cluster descriptions of the clusters of the given clustering_name

Usage

update_cluster_descriptions_by_cluster_annotation_mapping_df(
  loom,
  clustering.name,
  annotation.df = NULL,
  annotation.df.cluster.id.column.name = NULL,
  annotation.df.annotation.column.name = NULL,
  in.place = TRUE
)

Arguments

loom

The loom file handler.

clustering.name

The name of the clustering.

annotation.df

The data.frame containing the cluster annotatiion mapping

annotation.df.cluster.id.column.name

The column name of the given annotation.df containing the cluster ID values

annotation.df.annotation.column.name

The column name of the given annotation.df containing the annotation values.

in.place

If true update the given loom, otherwise return the update global meta data.


aertslab/SCopeLoomR documentation built on April 19, 2022, 11:25 a.m.