DownReq: DownReq

In rgbif: Interface to the Global Biodiversity Information Facility API

DownReq

Description

handles single requests for GbifQueue

Public fields

req

(list) internal holder for the request

type

(list) type, one of "lazy" (to be lazy evaluated) or "pre" (run with occ_download_exec internal fxn)

result

(list) holds the result of the http request

Methods

Public methods

• DownReq$new()

• DownReq$print()

• DownReq$run()

• DownReq$status()

• DownReq$clone()

---

Method new()

Create a new DownReq object

Usage

DownReq$new(x)

Arguments

x

either a lazy object with an object of class occ_download, or an object of class occ_download_prep

Returns

A new DownReq object

---

Method print()

print method for the DownReq class

Usage

DownReq$print(x, ...)

Arguments

x

self

...

ignored

---

Method run()

execute http request

Usage

DownReq$run()

Returns

nothing, puts the http response in ⁠$result⁠

---

Method status()

check http request status

Usage

DownReq$status()

Returns

output of occ_download_meta()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DownReq$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
res <- DownReq$new(occ_download_prep(pred("basisOfRecord", "LITERATURE"), 
  pred("year", "1956")
))
res
# res$run()
# res
# res$status()
# res$result

## End(Not run)

rgbif documentation built on Sept. 27, 2024, 5:07 p.m.