_pkgdown.yml

url: https://cgiachalis.github.io/storr.tiledb/
template:
  bootstrap: 5
  bootswatch: zephyr
  bslib:
    base_font:
      google: Rubik
    heading_font:
      google: Roboto Slab
    primary: '#090D14'
    link-color: '#1C4BC4ED'
    code-color: '#5D4311'
    text-decoration-color: '#151B21'
    body-color: '#1B222B'
home:
  sidebar:
    structure:
    - links
    - project
    - license
    - community
    - citation
    - authors
    - dev
    components:
      project:
        title: Related Software
        text: |
          [R6.TileDB](https://cgiachalis.github.io/R6.tiledb/) <br>
          [TileDB-R](https://tiledb-inc.github.io/TileDB-R/) <br>
          [TileDB Embedded](https://github.com/TileDB-Inc/TileDB)
navbar:
  title: storr.tiledb
  left:
  - text: ~
    href: index.html
    icon: fa-home fa-lg
    aria-label: storr.tiledb
  - text: Get Started
    href: articles/storr-tiledb.html
  - text: Reference
    href: reference/index.html
  - text: Articles
    menu:
    - text: storr.tiledb
    - text: API Usage
      href: articles/api.html
    - text: Data Model
      href: articles/data-model.html
    - text: ' FAQ'
      href: articles/faq.html
  - text: News
    href: news/index.html
reference:
- title: Storr Interface
  desc: |
    The storr interface is built on top of the R6 class system which provides the
    framework for managing content-addressable storage with TileDB. The key
    function to interact with a storr is `storr_tiledb()`. Additional
    functionality is provided for managing TileDB fragments as well as convenient
    storr utilities.
- subtitle: Storr
  desc: |
    Key functions to work with a 'storr' or creating a TileDB driver.
  contents:
  - storr_tiledb
  - storr_timetravel
  - driver_tiledb
- subtitle: Storr Management
  desc: |
    Utilities for Storr management.
  contents:
  - storr_copy
  - storr_move
  - storr_rename
- subtitle: Fragment Management
  desc: |
    Functionality to inspect and manage TileDB fragments.
  contents:
  - storr_fragments
  - storr_consolidate
  - storr_vacuum

- subtitle: Re-exported Functions
  contents:
  - reexports

- title: R6 Classes
  desc: |
    R6 classes that represent the storr interface and TileDB driver.
    These are internal objects and should not be used directly.
  contents:
  - CAS
  - TileDBDriver
  - TileDBStorr
  - TimeTravelDriver
  - StorrFragments
  - StorrTimeTravel