fg_save: Saves flowGraph object to a specified path.

View source: R/01_flowgraph_accessors.R

fg_saveR Documentation

Saves flowGraph object to a specified path.

Description

Saves flowGraph object to a specified path.

Usage

fg_save(fg, folder_path = NULL, save_plots = TRUE, paired = FALSE, ...)

Arguments

fg

flowGraph object to save.

folder_path

A string indicating the folder path to where the flowGraph object should save its elements; if this is the first time the object is being saved, this folder should be empty or if it is not yet created, the function will create it. If the object has previously been saved before and this parameter is set to NULL, the function will save the object into the save folder it was previously saved in.

save_plots

A logical indicating whether or not to save plots.

paired

A logical indicating whether the summary is paired; used in function fg_plot_box.

...

Other parameters for the fg_save_plots function.

Details

See generated README.md file.

Value

TRUE if flowGraph object successfully saved.

See Also

length,c("nrow", "nrow"),NULL map

Examples

 no_cores <- 1
 data(fg_data_pos2)
 fg <- flowGraph(fg_data_pos2$count, class=fg_data_pos2$meta$class,
                 no_cores=no_cores)

 fg_save(fg, "tmp")


aya49/flowGraph documentation built on Feb. 4, 2024, 6:40 p.m.