popsCopy: Copy Populations from One File to Another File

In IFC: Tools for Imaging Flow Cytometry

Copy Populations from One File to Another File

Description

Copies populations from a DAF file into a copy of another DAF file. Only creates new file with copied population.

Usage

popsCopy(
  from,
  into,
  write_to,
  pops,
  use_regex = FALSE,
  overwrite = FALSE,
  append_name = TRUE,
  offset = 0,
  endianness = .Platform$endian,
  verbose = FALSE,
  ...
)

Arguments

from	path to file to copy populations from.
into	path to file that will be used as a template to copy population into. Caution, it is mandatory that 'into' contains 'from' starting at 'offset'.
write_to	pattern used to export file. Placeholders, like "%d/%s_fromR.%e", will be substituted: -%d: with full path directory of 'into' -%p: with first parent directory of 'into' -%e: with extension of 'into' (without leading .) -%s: with shortname from 'into' (i.e. basename without extension). Exported file extension will be deduced from this pattern. Note that it has to be a .daf.
pops	regular expression or vector of desired populations present in 'from'. If missing, the default, all populations found will be copied. If given but not found, a warning will be sent.
use_regex	whether to use regex to pick up population into 'from'. Default is FALSE.
overwrite	whether to overwrite existing file or not. Default is FALSE. Note that if TRUE, it will overwrite exported file if path of 'into' and deduced from 'write_to' arguments are different. Otherwise, you will get an error saying that overwriting source file is not allowed. Note also that an original file, i.e. generated by IDEAS(R) or INSPIRE(R), will never be overwritten. Otherwise, you will get an error saying that overwriting original file is not allowed.
append_name	whether to append_name basename(from) to exported populations. Default is TRUE.
offset	Object number of 1st object of 'from' in 'into'. Default is 0.
endianness	The endian-ness ("big" or "little") of the target system for the file. Default is .Platform$endian. Endianness describes the bytes order of data stored within the files. This parameter may not be modified.
verbose	whether to display information (use for debugging purpose). Default is FALSE.
...	Other arguments to be passed.

Details

Populations are exported as tagged populations.

Value

a new file is created containing exported populations.
It invisibly returns full path of exported file.

IFC documentation built on Sept. 14, 2023, 1:08 a.m.