Package 'wcvpdata'

Check if the packaged version of WCVP is up to date.

Description

Usage

wcvp_check_version(silent = FALSE)

Arguments

silent

Suppress all messages and warnings.

Value

A logical value; TRUE if the packaged version is up to date, FALSE otherwise.

Examples

wcvp_check_version()

---

WCVP geographic distribution records

Description

Geographic records mapped to TDWG WGSRPD levels.

Usage

wcvp_distribution(as_data_frame = FALSE, columns = NULL)

Arguments

as_data_frame	If FALSE (the default), return a lazy Arrow Dataset. If TRUE, materialize the selected columns as a tibble.
columns	Optional character vector of columns to read when as_data_frame = TRUE.

Value

An arrow::Dataset or a tibble.

---

WCVP taxonomic data for distribution joins

Description

Taxonomic identifiers and hierarchy needed to join geographic records.

Usage

wcvp_distribution_names(as_data_frame = FALSE, columns = NULL)

Arguments

as_data_frame	If FALSE (the default), return a lazy Arrow Dataset. If TRUE, materialize the selected columns as a tibble.
columns	Optional character vector of columns to read when as_data_frame = TRUE.

Value

An arrow::Dataset or a tibble.

---

WCVP matching backbone

Description

A compact taxonomic backbone for matching plant names. Unlike the legacy lazy-data object, this reads no data until requested.

Usage

wcvp_matching_names(as_data_frame = FALSE, columns = NULL)

Arguments

as_data_frame	If FALSE (the default), return a lazy Arrow Dataset. If TRUE, materialize the selected columns as a tibble.
columns	Optional character vector of columns to read when as_data_frame = TRUE.

Value

An arrow::Dataset or a tibble.

---

Open a packaged WCVP Parquet dataset

Description

Opens one of the columnar WCVP tables bundled with the package. The returned Arrow Dataset is lazy: columns and rows are read only when a query is collected.

Usage

wcvp_open_dataset(table)

Arguments

table

One of "matching_names", "synonym_index", "distribution_names", or "distribution".

Value

An arrow::Dataset.

Examples

## Not run: 
wcvp_open_dataset("matching_names")

## End(Not run)

---

WCVP synonym index

Description

Accepted names and their nomenclatural synonym records.

Usage

wcvp_synonym_index(as_data_frame = FALSE, columns = NULL)

Arguments

as_data_frame	If FALSE (the default), return a lazy Arrow Dataset. If TRUE, materialize the selected columns as a tibble.
columns	Optional character vector of columns to read when as_data_frame = TRUE.

Value

An arrow::Dataset or a tibble.

---

Validate the local WCVP data against package metadata.

Description

Usage

wcvp_validate_data(silent = FALSE)

Arguments

silent

Suppress all messages and warnings.

Details

This function checks the bundled Parquet tables against package metadata and basic integrity constraints. It materializes identifier columns only.

Value

A logical value; TRUE if the local data matches the metadata and satisfies integrity checks, FALSE otherwise.

Examples

wcvp_validate_data()

---

Functions to help check the WCVP data is okay and up to date. View the version of WCVP available.

Description

Usage

wcvp_version(long = TRUE)

Arguments

long	Whether to return the version date with version number.

Value

A character string containing the version and date.

Examples

wcvp_version()

---