fd_save: Save Fluorescence Distribution 'fdmat' Object

In bpollner/flowdex: Extract Fluorescence Distribution Data from FCS Files and Recalculate to Events per Volume

Save Fluorescence Distribution 'fdmat' Object

Description

Saves the R-object containing the fluorescence distributions (the 'fdmat' object) in the standard data export / rawdata folder.

Usage

fd_save(fdmat, fns = NULL, expo.folder = ".", verbose = ".")

Arguments

fdmat	An object of class-fdmat as produced by makefdmat.
fns	Character length one or NULL. Possible character to be added to the filename.
expo.folder	Character length one. The name of the folder where exported data should reside. If left at the default '.', the value as defined in the settings file (key 'foN_rawData') will be used.
verbose	Logical. If status messages should be displayed. If left at the default '.', the value as defined in the settings file (key 'dV_verbose') will be used.

Details

The name of the saved file is put together using the default name for data exports (settings.R file key 'fiN_dataExport'), the name and type of the gating strategy, the character 'fdmatObj' and a possible filename suffix as defined in 'fns'.

Value

Invisible NULL; is called for its side effect, i.e. to save an object of class-fdmat to file.

See Also

Other Accessory functions: applyBandpass(), checkRepairFcsFiles(), cutFdmatToGate(), exportFdmatData(), fd_load(), genfs(), repairSID(), repairVolumes()

Examples

td <- tempdir()
data_source <- "https://github.com/bpollner/data/raw/main/flowdex_examples/flowdex_examples.zip"
check_download_data(td, data_source)
exp_home <- paste0(td, "/flowdex_examples")
old_wd <- getwd()
setwd(exp_home)
#
assign("get_settings_from_flowdex_package_root", TRUE, pos=.GlobalEnv)
# only required to make the examples run automatically
# you should not call 'assign' if you run the examples manually
# the effect of setting 'get_settings_from_flowdex_package_root' to TRUE
# is that the file 'flowdex_settings.R' in 'root' of the installed package
# 'flowdex' will be sourced instead of the one in the user-defined location.
#
fdmat <- flowdexit(stf = FALSE)
fd_save(fdmat, fns="_foo")
#
setwd(old_wd)

bpollner/flowdex documentation built on March 31, 2022, 3:21 a.m.