HSClient: R6 Class representing a HydroShare Client

In program--/HSClientR: A HydroShare API client for R

Description

In development

Methods

Public methods

• HSClient$new()

• HSClient$print()

• HSClient$authenticate()

• HSClient$query()

• HSClient$get_res()

• HSClient$next_res()

• HSClient$prev_res()

• HSClient$next_page()

• HSClient$prev_page()

• HSClient$clone()

---

Method new()

Initialize a HydroShare Client

Usage

HSClient$new()

Returns

A new HSClient object.

Note: A message will be issued since R6-object is still in development.

---

Method print()

Print HSClient object

Usage

HSClient$print()

Returns

HSClient output

---

Method authenticate()

Perform OAuth2 Authentication with HydroShare.

Usage

HSClient$authenticate()

Details

Note, the access token will be set as a header automatically if .token is NULL.

Returns

self, invisibly.

---

Method query()

Query/Search HydroShare

Usage

HSClient$query(...)

Arguments

...

Query parameters. See hs_resource parameters.

Returns

R6 object

---

Method get_res()

Get current resource

Usage

HSClient$get_res()

Returns

A tibble of the current resource

---

Method next_res()

Get next resource

Usage

HSClient$next_res()

Returns

Resource tibble. See $get_res.

---

Method prev_res()

Get previous resource

Usage

HSClient$prev_res()

Returns

Resource tibble. See $get_res.

---

Method next_page()

Get next search page

Usage

HSClient$next_page()

Returns

Query tibble. See $query.

---

Method prev_page()

Get previous search page

Usage

HSClient$prev_page()

Returns

Query tibble. See $query.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HSClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

program--/HSClientR documentation built on April 14, 2021, 8:40 a.m.