taxon_group_by_scientific_name: Aggregates Taxon and Specimen documents according to their...

View source: R/TaxonClient-wrapper.r

taxon_group_by_scientific_nameR Documentation

Aggregates Taxon and Specimen documents according to their scientific names

Description

This is a wrapper for the method group_by_scientific_name from class TaxonClient.

Usage

taxon_group_by_scientific_name(queryParams = list(),
  returnType = "data.frame", ...)

Arguments

queryParams

Named list or vector with names being the fields to be queried and values being the values to match

returnType

Either list or data.frame (default)

...

additional parameters passed to group_by_scientific_name from class nbaR.TaxonClient

Details

Returns a list with ScientificNameGroups, which contain Taxon and Specimen documents that share a scientific name

Value

list or data.frame, as specified by returnType

See Also

Other nbaR.TaxonClient-wrappers: taxon_count_distinct_values_per_group, taxon_count_distinct_values, taxon_count, taxon_download_query, taxon_dwca_get_data_set_names, taxon_dwca_get_data_set, taxon_dwca_query, taxon_find_by_ids, taxon_find, taxon_get_distinct_values_per_group, taxon_get_distinct_values, taxon_get_field_info, taxon_get_paths, taxon_get_settings, taxon_get_setting, taxon_is_operator_allowed, taxon_query


naturalis/nbaR documentation built on Nov. 12, 2023, 4:47 p.m.