mr: Return information related to Mendelian Randomisation

Description Usage Arguments Value Examples

View source: R/mr.R

Description

GET /mr

Usage

1
2
3
4
5
6
mr(
  exposure_trait = NULL,
  outcome_trait = NULL,
  pval_threshold = 1e-05,
  mode = c("table", "raw")
)

Arguments

exposure_trait

A trait name, e.g. "Body mass index", leaving exposure_trait as NULL will return MR information related to a specific outcome. NOTE: exposure_trait and outcome_trait cannot be both NULL.

outcome_trait

A trait name, e.g. "Coronary heart disease", leaving outcome_trait as NULL will return MR information related to a specific exposure_trait. NOTE: exposure_trait and outcome_trait cannot be both NULL.

pval_threshold

P-value threshold

mode

If mode = "table", returns a data frame (a tibble as per tidyverse convention). If mode = "raw", returns a raw response from EpiGraphDB API with minimal parsing done by httr.

Value

Data from GET /mr

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Returns a data frame
mr(exposure_trait = "Body mass index", outcome_trait = "Coronary heart disease")

# Returns raw response
mr(
  exposure_trait = "Body mass index", outcome_trait = "Coronary heart disease",
  mode = "raw"
) %>% str()

# Use a different threshold
mr(exposure_trait = "Body mass index", pval_threshold = 1e-8)

epigraphdb documentation built on March 29, 2021, 5:11 p.m.