Skip to contents

a5R build and session information

Source: R/a5-info.R
a5_info.Rd

Returns the versions behind a5R and its current settings, as a named list that prints as a summary. The same summary, on one line, is shown when the package is attached with library().

Usage

a5_info()

Value

A list of class a5_info with elements:

  • version: the a5R package version, a character scalar.

  • crate: the version of the bundled a5 Rust crate.

  • index: the A5 cell index version of a5R's ids, "1.0".

  • threads: the current thread count (see a5_threads()).

  • c_api: the version of the C API (see a5_c_api).

Details

The index element names the A5 cell index that a5R's ids belong to. Ids from different index versions look alike, and nothing in an id says which version wrote it (see a5_migrate()), so record index with stored cells and check it when reading them back. With Arrow and Parquet, a5_to_arrow_table() stores it in the schema metadata under the key "a5_index", and a5_from_arrow_table() checks it.

Examples

a5_info()
#> ── a5R 0.9.9.9008 ──────────────────────────────────────────────────────────────
#> a5 crate: 1.0.0
#> A5 index: 1.0
#> Threads: 1
#> C API: 1
a5_info()$index
#> [1] "1.0"