dataset: Search for more obscure dataset metadata.

In ropensci/rgbif: Interface to the Global Biodiversity Information Facility API

Search for more obscure dataset metadata.

Description

Search for more obscure dataset metadata.

Usage

dataset(
  country = NULL,
  type = NULL,
  identifierType = NULL,
  identifier = NULL,
  machineTagNamespace = NULL,
  machineTagName = NULL,
  machineTagValue = NULL,
  modified = NULL,
  query = NULL,
  deleted = FALSE,
  limit = NULL,
  start = NULL,
  curlopts = list()
)

Arguments

country	The 2-letter country code (as per ISO-3166-1) of the country publishing the dataset.
type	The primary type of the dataset. Available values : OCCURRENCE, CHECKLIST, METADATA, SAMPLING_EVENT, MATERIAL_ENTITY.
identifierType	An identifier type for the identifier parameter. Available values : URL, LSID, HANDLER, DOI, UUID, FTP, URI, UNKNOWN, GBIF_PORTAL, GBIF_NODE, GBIF_PARTICIPANT, GRSCICOLL_ID, GRSCICOLL_URI, IH_IRN, ROR, GRID, CITES, SYMBIOTA_UUID, WIKIDATA, NCBI_BIOCOLLECTION.
identifier	An identifier of the type given by the identifierType parameter.
machineTagNamespace	Filters for entities with a machine tag in the specified namespace.
machineTagName	Filters for entities with a machine tag with the specified name (use in combination with the machineTagNamespace parameter).
machineTagValue	Filters for entities with a machine tag with the specified value (use in combination with the machineTagNamespace and machineTagName parameters).
modified	The modified date of the dataset. Accepts ranges and a ” can be used as a wildcard, e.g.:modified=2023-04-01,
query	Simple full text search parameter. The value for this parameter can be a simple word or a phrase. Wildcards are not supported.
deleted	Logical specifying whether to return only deleted datasets.
limit	Controls the number of results in the page.
start	Determines the start for the search results.
curlopts	options passed on to crul::HttpClient.

Details

This function allows you to search for some more obscure dataset metadata that might not be possible with dataset_search(). For example, searching through registry machinetags.

Value

A list.

Examples

## Not run: 
dataset(limit=3)
dataset(country="US",limit=3)
dataset(type="CHECKLIST",limit=3)
dataset(identifierType = "URL",limit=3)
dataset(identifier = 168,limit=3)
dataset(machineTagNamespace = "metasync.gbif.org",limit=3)
dataset(machineTagName = "datasetTitle",limit=3)
dataset(machineTagValue = "Borkhart",limit=3)
dataset(modified = "2023-04-01", limit=3) 
dataset(q = "dog", limit=3) 
dataset(deleted=TRUE,limit=3)

## End(Not run)

ropensci/rgbif documentation built on April 20, 2024, 10:49 a.m.