xRDS: Function to read RDS files

In hfang-bristol/XGR: Exploring Genomic Relations for Enhanced Interpretation Through Enrichment, Similarity, Network and Annotation Analysis

Function to read RDS files

Description

xRDS is supposed to read RDS files.

Usage

xRDS(RDS = NULL, verbose = TRUE, placeholder = NULL, guid = NULL)

Arguments

RDS	which RDS to load. To support the remote reading of a compressed RDS file, it must be compressed via the gzip method
verbose	logical to indicate whether the messages will be displayed in the screen. By default, it sets to TRUE for display
placeholder	the characters to tell the placeholder of RDS files
guid	a valid (5-character) Global Unique IDentifier for an OSF project. For example, 'gskpn' (see 'https://osf.io/gskpn'). If a valid provided and the query matched, it has priority over the one specified via placeholder

Value

the loaded RDS. If the data cannot be loaded, it returns NULL.

Note

To enable 'guid', please also install a package "osfr" via BiocManager::install("osfr",dependencies=TRUE).

See Also

xRDS

Examples

guid <- 'gskpn'
## Not run: 
# from OSF
ig.HPPA <- xRDS('ig.HPPA', guid='gskpn')

## End(Not run)

hfang-bristol/XGR documentation built on Feb. 4, 2023, 7:05 a.m.