RvegCheck: RvegCheck: Inspect, Validate, Edit and Repair an Rveg Database

Description

A diagnostic and managing utility to verify the health and integrity of an Rveg database. RvegCheck() reads your database, checks for missing or corrupted data, and outputs a summary of the database's current state.

Usage

RvegCheck(database, export = "export", checklist = "default")

Value

Currently prints diagnostic information directly to the R console. If modifications are made, it exports the updated database files (*HEAD.csv

and *REL.csv) to the path specified by export.

Arguments

database: Character. The path and name of the existing Rveg database to inspect (e.g., "path/to/my_db").
export: Character. The output path and name where the modified database will be saved. Defaults to a temporary directory.
checklist: Character. The species checklist to validate the database against. By default, it uses the checklist defined in the database's metadata.

Details

Note: This function is currently under active development. #' At present, the function serves primarily as a diagnostic and metadata-repair tool. When run, it checks the database for a project_name and project_description. If these are missing, it will interactively prompt the user to supply them. It also prints vital database statistics, including the internal ID, creation date, last modification date, and any custom species added to the checklist.

In future updates, this function will also allow users to modify core database parameters, such as swapping the underlying species checklist or altering the header schema.

Examples

Run this code

if (interactive()) {
  # Inspect the built-in example database
  RvegCheck(
    database = file.path(path.package("Rveg"), "extdata/ExampleDB", "example_1")
  )
}