occurrencelist: occurrencelist description

Description Usage Arguments Examples

View source: R/occurrencelist.R

Description

occurrencelist description

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
  occurrencelist(sciname = NA, taxonconceptKey = NA,
    dataproviderkey = NA, dataresourcekey = NA,
    resourcenetworkkey = NA, basisofrecordcode = NA,
    minlatitude = NA, maxlatitude = NA, minlongitude = NA,
    maxlongitude = NA, minaltitude = NA, maxaltitude = NA,
    mindepth = NA, maxdepth = NA, cellid = NA,
    centicellid = NA, typesonly = NA,
    georeferencedonly = NA, coordinatestatus = NA,
    coordinateissues = NA, hostisocountrycode = NA,
    originisocountrycode = NA, originregioncode = NA,
    startdate = NA, enddate = NA, startyear = NA,
    endyear = NA, year = NA, month = NA, day = NA,
    modifiedsince = NA, startindex = NA, maxresults = 10,
    format = NA, icon = NA, mode = NA, stylesheet = NA,
    latlongdf = FALSE, removeZeros = FALSE,
    url = "http://data.gbif.org/ws/rest/occurrence/list?",
    ..., curl = getCurlHandle())

Arguments

sciname

scientitic name of taxon (character, see example)

taxonconceptKey

unique key for taxon (numeric)

dataproviderkey

Filter records to those provided by the supplied numeric key for a data provider. See provider(). (character)

dataresourcekey

Filter records to those provided by the supplied numeric key for a data resource See resource(). (character)

resourcenetworkkey

<what param does>

basisofrecordcode

return only records with the specified basis of record. Supported values are: "specimen, observation, living, germplasm, fossil, unknown". (character)

minlatitude

return only records from locations with latitudes greater than the supplied value (southern hemisphere with negative latitudes). (numeric)

maxlatitude

return only records from locations with latitudes lower than the supplied value (southern hemisphere with negative latitudes). (numeric)

minlongitude

return only records from locations with longitudes greater than the supplied value (western hemisphere with negative longitudes). (numeric)

maxlongitude

return only records from locations with longitudes lower than the supplied value (western hemisphere with negative longitudes). (numeric)

minaltitude

return only records from altitudes greater than or equal to the supplied value. (integer)

maxaltitude

return only records from altitudes less than or equals to the supplied value. (integer)

mindepth

return only records from depth greater than or equal to the supplied value. (numeric 2 decimal places)

maxdepth

return only records from depth less than or equals to the supplied value. (numeric 2 decimal places)

cellid

identifier for a one degree cell (O - 64,799)

centicellid

identifier for a 0.1 degree cell within a one degree cell

typesonly

if set to "true", return only records with a type status specified.

georeferencedonly

This option is deprecated.

coordinatestatus

if set to "true", return only records with coordinates. If set to "false", return only records without coordinates.

coordinateissues

if set to "true", return only records for which the portal has detected possible issues in georeferencing. If set to "false", return only records for which the portal has not detected any such issues.

hostisocountrycode

return only records served by providers from the country identified by the supplied 2-letter ISO code.

originisocountrycode

return only records of occurrences which occurred within the country identified by the supplied 2-letter ISO code.

originregioncode

return only records of occurrences which occurred within the region identified by the supplied 3-letter code.

startdate

return only records occurring on or after the supplied date (format YYYY-MM-DD, e.g. 2006-11-28).

enddate

return only records occurring on or before the supplied date (format YYYY-MM-DD, e.g. 2006-11-28).

startyear

return only records from during or after the supplied year.

endyear

return only records from during or before the supplied year.

year

return only records from during the supplied year.

month

return only records from during the supplied month (expressed as an integer in the range 1 to 12).

day

return only records from during the supplied day of month (expressed as an integer in the range 1 to 31).

modifiedsince

return only records which have been indexed or modified in the GBIF data portal index on or after the supplied date (format YYYY-MM-DD, e.g. 2006-11-28).

startindex

return the subset of the matching records that starts at the supplied (zero-based index).

maxresults

max number of results (integer) (1-10000)

format

specifies the format in which the records are to be returned,

icon

<what param does>

mode

specifies whether the response data should (as far as possible) be the raw values originally retrieved from the data resource or processed (normalised) values used within the data portal (character)

stylesheet

sets the URL of the stylesheet to be associated with the

latlongdf

return a data.frame of lat/long's for all occurrences (logical)

removeZeros

remove records with both Lat Long zero values (logical)

url

the base GBIF API url for the function (should be left to default)

...

optional additional curl options (debugging tools mostly)

curl

If using in a loop, call getCurlHandle() first and pass the returned value in here (avoids unnecessary footprint)

Examples

1
2
3
4
## Not run: 
occurrencelist(sciname = 'Accipiter erythronemius', coordinatestatus = TRUE, maxresults = 100)

## End(Not run)

sckott/rgbif_scott documentation built on May 26, 2017, 3:46 a.m.