Last data update: 2014.03.03

R: Get a common SNP list between two SNP list objects
snpgdsSNPListIntersectR Documentation

Get a common SNP list between two SNP list objects

Description

Get a common SNP list by comparing their rs id, chromosome indices and positions.

Usage

snpgdsSNPListIntersect(snplist1, snplist2)

Arguments

snplist1

the first SNP list object snpgdsSNPListClass

snplist2

the second SNP list object snpgdsSNPListClass

Value

Return an object of snpgdsSNPListClass including the following components:

rs.id

SNP id

chromosome

SNP chromosome index

position

SNP physical position in basepair

allele

reference / non-ref alleles from the first SNP list object

afreq

allele frequency from the first SNP list object

Author(s)

Xiuwen Zheng

See Also

snpgdsSNPList, snpgdsSNPListStrand

Examples

# open an example dataset (HapMap)
genofile <- snpgdsOpen(snpgdsExampleFileName())

# to get a snp list object
snplist1 <- snpgdsSNPList(genofile)
snplist2 <- snpgdsSNPList(genofile)

# a common snp list
snplist <- snpgdsSNPListIntersect(snplist1, snplist2)

summary(snplist$afreq)

# close the file
snpgdsClose(genofile)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(SNPRelate)
Loading required package: gdsfmt
SNPRelate -- supported by Streaming SIMD Extensions 2 (SSE2)
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/SNPRelate/snpgdsSNPListIntersect.Rd_%03d_medium.png", width=480, height=480)
> ### Name: snpgdsSNPListIntersect
> ### Title: Get a common SNP list between two SNP list objects
> ### Aliases: snpgdsSNPListIntersect
> ### Keywords: GDS GWAS
> 
> ### ** Examples
> 
> # open an example dataset (HapMap)
> genofile <- snpgdsOpen(snpgdsExampleFileName())
> 
> # to get a snp list object
> snplist1 <- snpgdsSNPList(genofile)
> snplist2 <- snpgdsSNPList(genofile)
> 
> # a common snp list
> snplist <- snpgdsSNPListIntersect(snplist1, snplist2)
> 
> summary(snplist$afreq)
   Min. 1st Qu.  Median    Mean 3rd Qu.    Max. 
 0.0000  0.2043  0.5054  0.5056  0.8088  1.0000 
> 
> # close the file
> snpgdsClose(genofile)
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>