specimen_get_distinct_values: Get all different values that exist for a field

View source: R/SpecimenClient-wrapper.r

specimen_get_distinct_valuesR Documentation

Get all different values that exist for a field

Description

This is a wrapper for the method get_distinct_values from class SpecimenClient.

Usage

specimen_get_distinct_values(field = NULL, queryParams = list(),
  returnType = "data.frame", ...)

Arguments

field

Name of field in specimen object, type:

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 get_distinct_values from class nbaR.SpecimenClient

Details

A list of all fields for specimen documents can be retrieved with /metadata/getFieldInfo

Value

scalar

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_field_info, specimen_get_ids_in_collection, specimen_get_named_collections, specimen_get_paths, specimen_get_settings, specimen_get_setting, specimen_group_by_scientific_name, specimen_is_operator_allowed, specimen_query


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