get_gen: Fonction générique pour retirer de l'information depuis l'API...

In TheoreticalEcosystemEcology/rcoleo: rcoleo

Description

Fonction générique pour retirer de l'information depuis l'API de Coléo

Usage

get_gen(
  endpoint,
  query = NULL,
  limit = 100,
  verbose = TRUE,
  token = bearer(),
  ...
)

Arguments

endpoint	character désignant le point d'entrée pour le retrait des données. Un point d'entrée peut être vu comme une table de la base de données.
query	list de paramètres à passer avec l'appel sur le endpoint.
token	character jeton d'accès pour authentification auprès de l'API
...	httr options; arguments de la fonction httr::GET()
flatten	logical aplatir automatiquement un data.frame imbriqués dans un seul data.frame (obsolete si l'objet retourné n'est pas un data.frame)
output	character choix du type d'objet retourné: data.frame, list, json

Details

Les points d'accès de l'API sont énuméré dans l'environment de coléo, voir print(endpoints)

Value

Retourne un objet de type list contenant les réponses de l'API. Chaque niveau de la liste correspond à une page. Pour chacun des appels sur l'API (page), la classe retourné est getSuccess ou getError. Une réponse de classe getSuccess est une liste à deux niveaux composé du contenu (body), et la réponse httr::response. Une réponse de classe getError dispose de la même structure mais ne contiendra pas de body, seulement la réponse de l'API.

Examples

## Not run: 
resp <- get_gen("/cells")
length(resp) # Nombre de pages retourné par l'appel sur le point d'accès de l'API.
str(resp[[1]])
class(resp[[1]])

## End(Not run)

TheoreticalEcosystemEcology/rcoleo documentation built on Oct. 20, 2020, 6:42 p.m.