Skip to contents

rds cache

Source: R/rds_cache_class.R
rds_cache.Rd

A data.frame stored as an RDS file. Intended to be used with rest_api objects as mechanism for caching search results. The data.frame for an rds_cache object must have a column named ".search".

Usage

rds_cache(
  source = character(0),
  data = data.frame(.search = character(0)),
  ...
)

Arguments

source

(ANY) The source of annotation data. The default is character(0).

data

(data.frame, NULL) A data.frame of annotation data. The default is data.frame(.search = character(0)).

...

Additional slots and values passed to struct_class.

Value

A rds_cache object. This object has no output slots.

Inheritance

A rds_cache object inherits the following struct classes:

[rds_cache] -> [rds_database] -> [annotation_database] -> [annotation_source] -> [struct_class]

See also

Other annotation databases: AnnotationDb_database, GO_database, annotation_database, annotation_source, excel_database, rdata_database, rds_database

Examples

M = rds_cache( tag = character(0), data = data.frame(id=NA), source =
"ANY")
#> Error in validObject(.Object): invalid class “rds_cache” object: Column(s) named ".search" must be present in the data.frame for this source.