Create SOMATileDBContext for Census

Create a SOMATileDBContext suitable for using with open_soma(). Typically open_soma() creates a context automatically, but one can be created separately in order to set custom configuration options, or to share it between multiple open Census handles.

Usage

new_SOMATileDBContext_for_census(
  census_version_description,
  mirror = "default",
  ...
)

Arguments

census_version_description

The result of get_census_version_description() for the desired Census version.

mirror

The name of the intended census mirror (or get_census_mirror_directory()[[name]] to save the lookup), or NULL to configure for local file access.

...

Custom configuration options.

Value

SOMATileDBContext object for open_soma().

Examples

census_desc <- get_census_version_description("stable")
ctx <- new_SOMATileDBContext_for_census(census_desc, "soma.init_buffer_bytes" = paste(4 * 1024**3))
census <- open_soma("stable", tiledbsoma_ctx = ctx)
#> The stable Census release is currently 2023-12-15. Specify census_version = "2023-12-15" in future calls to open_soma() to ensure data consistency.
census$close()