save_ncfs: save/load a ncdfFlowSet object to/from disk.

Description Usage Arguments Value See Also Examples

View source: R/ncdfIO.R

Description

The ncdfFlowSet object contains two parts: R object and cdf file. Save/load a ncdfFlowSet mainly involves the R part using saveRDS/readRDS.

Usage

1
2
3
4
5
6
7
8
save_ncfs(
  ncfs,
  path,
  overwrite = FALSE,
  cdf = c("copy", "move", "link", "skip", "symlink")
)

load_ncfs(path)

Arguments

ncfs

A ncdfFlowSet

path

A character scalar giving the path to save/load the ncdfFlowSet to/from.

overwrite

A logical scalar specifying whether to overwrite the existing folder.

cdf

a character scalar. The valid options are :"copy","move","skip","symlink","link" specifying what to do with the cdf data file. Sometime it is more efficient to move or create a link of the existing cdf file to the archived folder.

Value

load_ncfs returns a ncdfFlowSet object

See Also

ncdfFlowSet-class

Examples

1
2
3
4
5
6
7
## Not run: 
	#ncfs is a ncdfFlowSet
	save_ncfs(fs, path = "tempFolder")
	fs1 <- load_ncfs(path = "tempFolder")


## End(Not run)

ncdfFlow documentation built on Nov. 8, 2020, 7:52 p.m.