TNRS_core: Handle API access and format

View source: R/TNRS_core.R

TNRS_coreR Documentation

Handle API access and format

Description

Internal function for handling accessing the API,data formatting, and errors

Usage

TNRS_core(
  url = "https://tnrsapi.xyz/tnrs_api.php",
  mode = "resolve",
  data_json = NULL,
  sources = c("wcvp", "wfo"),
  classification = "wfo",
  matches = "best",
  accuracy = NULL,
  batches = NULL
)

Arguments

url

Server URL to use. Defaults to the stable production version

mode

Character. Options are "resolve" and "parse". Default option is "resolve"

data_json

Either NULL (the default) or properly formatted json

sources

Character. Taxonomic sources to use. Default is c("wcvp", "wfo"). Options include "wfo", "wcvp", and "cact".

classification

Character. Family classification to use. Currently options include "wfo" (the default).

matches

Character. Should all matches be returned ("all") or only the best match ("best", the default)?

accuracy

numeric. If specified, only matches with a score greater than or equal to the supplied accuracy level will be returned.

batches

NULL or Numeric. Optional number of batches to divide the request into for parallel processing. CUrrently isn't implemented

Note

For more information on current sources, use the function TNRS_sources()


TNRS documentation built on June 24, 2024, 5:19 p.m.