mgnify_request: GET request from the ENA

View source: R/mgnify_api.R

mgnify_requestR Documentation

GET request from the ENA

Description

GET request from the ENA

Usage

mgnify_request(
  url,
  max_pages = NULL,
  query = list(),
  verbose = TRUE,
  cache_file = "mgnify_request.RDS",
  cache_break = 10,
  use_cache = TRUE,
  ...
)

Arguments

url

ENA API url

max_pages

Max number of pages to return. If NULL, all pages returned.

query

Query list passed to httr::GET

verbose

Verbose output?

cache_file

File name to cache (checkpoint) the results. Useful for big queries in case the job is interuppted.

cache_break

Write cache file every N pages.

use_cache

Read the cache file, if it exists?

...

Parameters passed to httr::GET

Value

data.frame

Examples

mgnify_request('https://www.ebi.ac.uk/metagenomics/api/v1/biomes', max_pages = 3)

leylabmpi/LeyLabRMisc documentation built on Nov. 3, 2022, 3:45 p.m.