gc_get: Get a GWAS Catalog resource

View source: R/request.R

gc_getR Documentation

Get a GWAS Catalog resource

Description

This function gets a GWAS Catalog by URL endpoint. The response must correspond to one of the four types of entities: studies, associations, variants or traits.

Usage

gc_get(
  resource_url,
  base_url = gwas_rest_api_base_url,
  verbose = FALSE,
  warnings = TRUE,
  page_size = 20L
)

Arguments

resource_url

Endpoint URL. The endpoint is internally appended to the base_url. It should start with a forward slash (/).

base_url

The GWAS REST API base URL (one should not need to change its default value).

verbose

Whether to be chatty.

warnings

Whether to print warnings.

page_size

Page parameter used in the URL endpoint.

Value

A normalised JSON-list corresponding to either studies, associations, variants or traits.


gwasrapidd documentation built on May 29, 2024, 4:31 a.m.