Skip to contents

Retrieve updated cellxgene database metadata

Usage

db(overwrite = .db_online() && .db_first())

Arguments

overwrite

logical(1) indicating whether the database of collections should be updated from the internet (the default, when internet is available and, in an interactive session, the user requests the update), or read from disk (assuming previous successful access to the internet). overwrite = FALSE might be useful for reproducibility, testing, or when working in an environment with restricted internet access.

Value

db() returns an object of class 'cellxgene_db', summarizing available collections, datasets, and files.

Details

The database is retrieved from the cellxgene data portal web site. 'collections' metadata are retrieved on each call; metadata on each collection is cached locally for re-use.

Examples

db()
#> Collections ■■                                 2% | ETA:  2m
#> Collections ■■                                 3% | ETA:  2m
#> Collections ■■■                                7% | ETA:  1m
#> Collections ■■■■■                             13% | ETA:  1m
#> Collections ■■■■■■■                           21% | ETA: 45s
#> Collections ■■■■■■■■■                         26% | ETA: 43s
#> Collections ■■■■■■■■■■                        29% | ETA: 46s
#> Collections ■■■■■■■■■■■                       33% | ETA: 42s
#> Collections ■■■■■■■■■■■■■■                    42% | ETA: 33s
#> Collections ■■■■■■■■■■■■■■■■                  49% | ETA: 28s
#> Collections ■■■■■■■■■■■■■■■■■                 54% | ETA: 25s
#> Collections ■■■■■■■■■■■■■■■■■■                56% | ETA: 27s
#> Collections ■■■■■■■■■■■■■■■■■■■               59% | ETA: 25s
#> Collections ■■■■■■■■■■■■■■■■■■■■■             66% | ETA: 21s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■           74% | ETA: 15s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■         80% | ETA: 11s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■       86% | ETA:  8s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■     93% | ETA:  4s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■    96% | ETA:  2s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■    97% | ETA:  2s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■   99% | ETA:  1s
#> Collections ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■  100% | ETA:  0s
#> cellxgene_db
#> number of collections(): 235
#> number of datasets(): 1488
#> number of files(): 2723