idig_top_records: Top records endpoint

In ridigbio: Interface to the iDigBio Data API

Top records endpoint

Description

Top specimen records summaries.

Usage

idig_top_records(rq = FALSE, top_fields = FALSE, count = 0, ...)

Arguments

rq	iDigBio record query in nested list format
top_fields	vector of field names to summarize by
count	maximum number of results to return, capped at 1000
...	additional parameters

Details

Summarize the count of specimen records in iDigBio according to unique values in the fields passed. This operates similarly to a SELECT DISTINCT count(field_name) query in SQL. When multiple fields are passed, the summaries are nested eg fields=c("country", "genus") would result in counting the top 10 genera in each of the top 10 countries for a total of 100 counts.

Value

nested list of field values with counts of specimen records

Author(s)

Matthew Collins

ridigbio documentation built on Oct. 1, 2024, 9:06 a.m.