specimen_get_field_info: Returns extended information for each field of a specimen...

In naturalis/nbaR: R Package Client for the Netherlands Biodiversity API

Returns extended information for each field of a specimen document

Description

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

Usage

specimen_get_field_info(returnType = "data.frame", ...)

Arguments

returnType	Either list or data.frame (default)
...	additional parameters passed to get_field_info from class nbaR.SpecimenClient

Details

Info consists of whether the fields is indexed, the ElasticSearch datatype and a list of allowed operators

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_distinct_values, 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.