load_cytoframe: Load the cytoframe from disk

Description Usage Arguments See Also

View source: R/cytoframe.R

Description

Load the cytoframe from disk

Usage

1
2
3
4
5
6
7
load_cytoframe(
  uri,
  on_disk = TRUE,
  readonly = on_disk,
  num_threads = 1L,
  cred = NULL
)

Arguments

uri

path to the cytoframe file

on_disk

logical flag indicating whether to keep the data on disk and load it on demand. Default is TRUE.

readonly

logical flag indicating whether to open h5 data as readonly. Default is TRUE. And it is valid when on_disk is set to true.

cred

credentials for s3 access. It is a list containing elements of "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_REGION" when NULL, read the default credential file from disk (e.g., ~/.aws/credentials)

See Also

Other cytoframe/cytoset IO functions: cf_get_uri(), cf_write_disk(), cf_write_h5(), cf_write_tile(), cs_get_uri(), load_cytoframe_from_fcs(), load_cytoset_from_fcs()


flowWorkspace documentation built on Nov. 8, 2020, 8:08 p.m.