get_variants_by_genomic_range: Get GWAS Catalog variants by genomic range

View source: R/get_variants.R

get_variants_by_genomic_rangeR Documentation

Get GWAS Catalog variants by genomic range

Description

Gets variants by genomic range.

Usage

get_variants_by_genomic_range(
  chromosome = NULL,
  start = NULL,
  end = NULL,
  verbose = FALSE,
  warnings = TRUE,
  page_size = 20L
)

Arguments

chromosome

A character vector of human chromosome names: autosomal and sexual chromosomes only, i.e., 1–22, X and Y.

start

Start position of range (starts at 1).

end

End position of range (inclusive).

verbose

Whether the function should be verbose about the different queries or not.

warnings

Whether to print warnings.

page_size

An integer scalar indicating the page value to be used in the JSON requests, can be between 1 and 1000.

Value

A variants object.


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