open_flowjo_xml: Open/Close a flowJo workspace

In RGLab/CytoML: A GatingML Interface for Cross Platform Cytometry Data Sharing

Open/Close a flowJo workspace

Description

Open a flowJo workspace and return a flowjo_workspace object. Close a flowjo_workspace, destroying the internal representation of the XML document, and freeing the associated memory.

Usage

open_flowjo_xml(file, options = 0, sample_names_from = "keyword", ...)

Arguments

file	Full path to the XML flowJo workspace file.
options	xml parsing options passed to xmlTreeParse. See http://xmlsoft.org/html/libxml-parser.html#xmlParserOption for details.
sample_names_from	character specifying where in the XML workspace file to obtain the sample names, either "keyword" for the included $FIL keyword for each sample, or "sampleNode" for the name of the sample node
...	not used

Details

Open an XML flowJo workspace file and return a flowjo_workspace object. The workspace is represented using a XMLInternalDocument object. Close a flowJoWorkpsace after finishing with it. This is necessary to explicitly clean up the C-based representation of the XML tree. (See the XML package).

Value

a flowjo_workspace object.

Examples

## Not run: 
	file<-"myworkspace.xml"
	ws<-open_flowjo_xml(file);
	ws

## End(Not run)

RGLab/CytoML documentation built on Feb. 1, 2024, 12:34 a.m.