concatFCS {CATALYST} | R Documentation

## FCS file Concatenation

### Description

Concatenates all input data to a single file or object.

### Usage

    concatFCS(x, ...)

    ## S4 method for signature 'flowSet'
    concatFCS(x, out_path = NULL, fn = NULL,
      fn_sep = "_", by_time = TRUE, file_num = FALSE, pars = NULL,
      desc = NULL)

    ## S4 method for signature 'character'
    concatFCS(x, out_path = NULL, fn = NULL,
      fn_sep = "_", by_time = TRUE, file_num = FALSE)

    ## S4 method for signature 'list'
    concatFCS(x, out_path = NULL, fn = NULL,
      fn_sep = "_", by_time = TRUE, file_num = FALSE)

### Arguments

`x` | can be either a `flowSet`, a list of `flowFrame`s, a character specifying the location of the FCS files to be concatinated, or a vector of FCS file names.
`...` | optional arguments.
`out_path` | character string. If specified, an FCS file of the concatenated data will be written to this location. If NULL (default), a `flowFrame` will be returned.
`fn` | a character string to use as the output file name. Defaults to the file name of the first input FCS file or `flowFrame`, respectively.
`fn_sep` | a character string to use to separate the output file name's prefix from the appendage.
`by_time` | logical. Specifies whether files should be ordered by time of acquisition.
`file_num` | logical. Specifies whether a file number column should be added.
`pars, desc` | optional character vectors of channel names & descriptions to use when merging files.

### Value

a `flowFrame` containing measurement intensities of all input data or a character of the FCS file name.

### Author(s)

Helena Lucia Crowell helena.crowell@uzh.ch

### Examples

    data(raw_data)
    concatFCS(raw_data)

[Package CATALYST version 1.8.7 Index]