fd_load: Load Fluorescence Distribution 'fdmat' Object

View source: R/gen-functions.R

fd_loadR Documentation

Load Fluorescence Distribution 'fdmat' Object

Description

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

Usage

fd_load(fn = NULL, expo.folder = ".", verbose = ".")

Arguments

fn

Character length one, the name of the file.

expo.folder

The name of the folder where the file should be looked for. 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

If 'fn' is left at NULL, the file containing the default name for exported data and gating strategy is being attempted to load.

Value

An object of class-fdmat as produced by makefdmat or flowdexit.

See Also

Other Accessory functions: applyBandpass(), checkRepairFcsFiles(), cutFdmatToGate(), exportFdmatData(), fd_save(), 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()
# and load the same again on an other shiny day... 
fdmat <- fd_load()
#
setwd(old_wd)

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