get_clustering_sc3_subplan: Get a subplan for SC3 clustering.

View source: R/plans_common_clustering.R

get_clustering_sc3_subplanR Documentation

Get a subplan for SC3 clustering.

Description

Get a subplan for SC3 clustering.

Usage

get_clustering_sc3_subplan(
  sce_target_name,
  cluster_sc3_enabled,
  cluster_sc3_k_,
  cluster_sc3_n_cores,
  is_integration,
  plots_out_dir,
  seed = 1
)

Arguments

sce_target_name

A character scalar: name of target representing a SCE object that will be used for SC3 clustering.

cluster_sc3_enabled

A logical scalar: if FALSE, disable the selected clustering and set all corresponding targets to NULL.

cluster_sc3_k_

An integer vector: ks for SC3.

cluster_sc3_n_cores

An integer scalar: number of cores to use for parallel execution of the SC3 algorithm.

is_integration

A logical scalar: if TRUE, clustering results will be named as ⁠cluster_int_sc3_k<k>⁠. If FALSE, they will be named as ⁠cluster_sc3_k<k>⁠.

plots_out_dir

A character scalar: path to output directory to save plots (e.g. clustree::clustree()).

seed

An integer scalar: random seed for SC3.

Value

drake::drake_plan()


bioinfocz/scdrake documentation built on Sept. 19, 2024, 4:43 p.m.