LDlinkR (version 1.0.2)

LDpair: Query LDpair API

Description

Query LDpair API

Usage

LDpair(var1, var2, pop = "CEU", token = NULL, output = "table", file = FALSE)

Arguments

var1

the first RS number or genomic coordinate (e.g. "chr7:24966446")

var2

the second RS number or genomic coordinate (e.g. "ch7:24966446")

pop

a 1000 Genomes Project population(s), (e.g. YRI or CEU), multiple allowed, default = "CEU"

token

LDlink provided user token, default = NULL, register for token at https://ldlink.nci.nih.gov/?tab=apiaccess

output

two output options available, "text", which displays a two-by-two matrix displaying haplotype counts and allele frequencies along with other statistics, or "table", which displays the same data in rows and columns, default = "table"

file

Optional character string naming a path and file for saving results. If file = FALSE, no file will be generated, default = FALSE.

Value

text or data frame, dependning on the output option

Examples

# NOT RUN {
LDpair(var1 = "rs3", var2 = "rs4", pop = "YRI", token = Sys.getenv("LDLINK_TOKEN"))
# }
# NOT RUN {
LDpair("rs3", "rs4", "YRI", token = Sys.getenv("LDLINK_TOKEN"), "text")
# }
# NOT RUN {
# }