query_names: Query taxon usage names

View source: R/query_names.R

query_namesR Documentation

Query taxon usage names

Description

A quick display of stored taxon names by matching them with a character string.

This function can also provide details about the associated taxon concpets, taxonomies and accepted names for each taxonomy.

Usage

query_names(conn, ...)

## S3 method for class 'PostgreSQLConnection'
query_names(
  conn,
  query,
  schema = "plant_taxonomy",
  case = FALSE,
  exact = FALSE,
  concepts = FALSE,
  accepted = FALSE,
  ...
)

Arguments

conn

Connection to the database as PostgreSQLConnection.

...

Further arguments passed among methods.

query

A character value that will be matched with the names stored in the database.

schema

Character value indicating the name of the schema containing taxonomic information within the database.

case

A logical value indicating whether the match should be case sensitive (TRUE) or not (FALSE, the default). I does not apply if 'exact = TRUE'.

exact

A logical value indicating whether the exact string is queried.

concepts

A logical value indicating whether taxon concepts should be displayed (TRUE) or just the names (FALSE, the default).

accepted

A logical value indicating whether the respective accepted names should be displayed (TRUE) or not (FALSE, the default). This works only if 'concepts = TRUE'.


kamapu/vegtableDB documentation built on June 18, 2024, 1:13 a.m.