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

View source: R/SpecimenClient-wrapper.r

specimen_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 SpecimenClient.

Usage

specimen_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.SpecimenClient

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.SpecimenClient-wrappers: specimen_count_distinct_values_per_group, specimen_count_distinct_values, specimen_count, specimen_download_query, specimen_dwca_get_data_set_names, specimen_dwca_get_data_set, specimen_dwca_query, specimen_exists, specimen_find_by_ids, specimen_find_by_unit_id, specimen_find, specimen_get_distinct_values_per_group, specimen_get_distinct_values, specimen_get_field_info, specimen_get_ids_in_collection, specimen_get_named_collections, specimen_get_paths, specimen_get_settings, specimen_get_setting, specimen_is_operator_allowed, specimen_query


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