indexDatabase: Index BioticExplorer database

In MikkoVihtakari/BioticExplorerServer: R package to generate and update the server-side data for BioticExplorer

Index BioticExplorer database

Description

Loads BioticExplorer database and creates an index used by BioticExplorer to save processing time.

Usage

indexDatabase(
  connection,
  dbIndexFile = "~/IMR_biotic_BES_database/dbIndex.rda",
  fileOnly = TRUE
)

Arguments

connection	Object defining the duckdb connection. Typically made within compileDatabase.
dbIndexFile	Character string specifying the file path where the index of the database should be saved. Must include .rda at the end. The index is used by BioticExplorer.
fileOnly	Logical indicating whether the result should only be saved to a file and not returned. If FALSE, no file is made and the result is returned instead.

Author(s)

Mikko Vihtakari, Ibrahim Umar (Institute of Marine Research)

MikkoVihtakari/BioticExplorerServer documentation built on Feb. 28, 2025, 11:23 p.m.