write_clusters_data: Write clustering output

Description Usage Arguments

View source: R/io.R

Description

Write clustering output

Usage

1
2
3
4
5
6
write_clusters_data(
  clustered.data,
  base.name,
  output.dir = "./",
  pooled.only = FALSE
)

Arguments

clustered.data

A data.frame containing the clustered data. Each row corresponds to cell. The data.frame must include a column called cellType, indicating cluster membership

base.name

The base name for naming output files. This is only used in two cases:

  • If clustered_data does not contain a column called sample

  • If clustered_data represents a pooled clustering result (e.g. derived from grappolo::cluster_fcs_files_groups), the pooled data will be written in a directory called pooled/base.name (but see pooled.only below)

output.dir

The output directory. A subfolder called clusters_data will be created in this directory, and all the data will be written into it

pooled.only

If this is true, only pooled data will be written and no sepearate pooled directory will be created


ParkerICI/scgraphs documentation built on April 30, 2021, 1:10 p.m.