plco.get_variants: Retrieves variants for a specified phenotype, sex, and...

In CBIIT/gwas-explorer-r-sdk: Query GWAS results from studies supported by the National Cancer Institute

Description

Retrieves variants for a specified phenotype, sex, and ancestry

Usage

plco.get_variants(
  phenotype_id,
  sex,
  ancestry,
  chromosome = NULL,
  columns = NULL,
  snp = NULL,
  position = NULL,
  position_min = NULL,
  position_max = NULL,
  p_value_min = NULL,
  p_value_max = NULL,
  order_by = "p_value",
  order = "asc",
  offset = 0,
  limit = 1000,
  ...
)

Arguments

phenotype_id	A numeric phenotype id
sex	A character vector specifying a sex to retrieve data for
ancestry	A character vector specifying ancestries to retrieve data for
chromosome	Optional. A character vector specifying a chromosome to retrieve data for
columns	Optional. A character vector specifying properties to include for each variant
snp	Optional. A character vector specifying snps to retrieve
position	Optional. A numeric value specifying the chromosome position to retrieve data for
position_min	Optional. A numeric value specifying the minimum chromosome position for variants
position_max	Optional. A numeric value specifying the maximum chromosome position for variants
p_value_min	Optional. A numeric value specifying the minimum p-value for variants
p_value_max	Optional. A numeric value specifying the maximum p-value for variants
order_by	Optional. A character vector specifying the property to sort variants by
order	Optional. A character vector specifying the order to sort variants by. Either "asc" or "desc"
offset	Optional. A numeric value specifying the offset from which to begin retrieving variants
limit	Optional. A numeric value specifying the maximum number of variants to retrieve

Value

A dataframe containing variants

Examples

plco.get_variants(1010, "female", "european", limit=100)

CBIIT/gwas-explorer-r-sdk documentation built on Dec. 17, 2021, 11:59 a.m.