gh_generate_template: generate a partially complete csv template from the existing...

View source: R/csvTemplate-parser.R

gh_generate_templateR Documentation

generate a partially complete csv template from the existing gating hierarchy

Description

To ease the process of replicating the existing (usually a manual one) gating schemes, this function populate an empty gating template with the 'alias', 'pop', 'parent' and 'dims' columns that exacted from an GatingHierarchy, and leave the other columns (e.g. 'gating_method') blank. So users can make changes to that template instead of writing from scratch.

Usage

gh_generate_template(gh)

Arguments

gh

a GatingHierarchy likely parsed from a xml workspace

Value

a gating template in data.frame format that requires further edition after output to csv

Examples

library(flowWorkspace)
dataDir <- system.file("extdata",package="flowWorkspaceData")
gs <- load_gs(list.files(dataDir, pattern = "gs_manual",full = TRUE))
gh_generate_template(gs[[1]])

RGLab/openCyto documentation built on Aug. 23, 2023, 6:53 a.m.