R: Fetch dataset metadata.

dataset {robis} | R Documentation

## Fetch dataset metadata.

### Description

`dataset` returns dataset metadata based on the id or some query parameters.

### Usage

    dataset(id = NULL, scientificname = NULL, q = NULL, obisid = NULL, aphiaid =
      NULL, groupid = NULL, areaid = NULL, nodeid = NULL, startdate = NULL, enddate = NULL,
      startdepth = NULL, enddepth = NULL, geometry = NULL, verbose = FALSE)

### Arguments

`id` | integer vector. One or more dataset ids, if provided all the other query parameters will be ignored.
`scientificname` | character vector. The full scientific name, with authorship and date information if known.
`q` | character. The search string.
`obisid` | integer vector. The OBIS identifier of the species.
`aphiaid` | integer vector. The WoRMS identifier of the species.
`groupid` | integer. The taxonomic group id. See also `group` for the list of taxonomic groups.
`areaid` | integer vector. The OBIS area identifier (country, marine world heritage site, ABNJ, EBSA, ...). See also `area` for the list areas.
`nodeid` | integer vector. The OBIS node identifier. See also `node` for the list of nodes.
`startdate` | The earliest date on which the Event occurred.
`enddate` | The latest date on which the Event occurred.
`startdepth` | The minimum depth below the sea surface.
`enddepth` | The maximum depth below the sea surface.
`geometry` | A wkt geometry string.
`verbose` | logical. Optional parameter to enable verbose logging (default = `FALSE`).

### Value

The dataset metadata records.

### Examples

    datasets <- dataset(id = 1)
    datasets <- dataset(q = "MICROBIS")
    datasets <- dataset(nodeid = c(0,1))

[Package robis version 1.0.0 Index]