gbradburd / SpaceMix

29 stars 10 forks source link

############################################################ ############################################################

SpaceMix ReadMe

############################################################ ############################################################

PREAMBLE Caveat user: this code is still in beta. Please contact Gideon Bradburd at bradburd(at)umich(dot)edu with bug reports or questions. Please thoroughly read the documentation and go through the vignette first to make sure your question has not already been addressed.

Also, remember to check the git for updates!

README This repository contains the R package SpaceMix and accompanying vignette. To install the package you can either:

(1) download the .tar.gz file and install using

install.packages("~/SpaceMix_X.tar.gz",repos=NULL)

where "X" in the package name denotes the number of the most current version.

OR

(2) install directly from github using

require(devtools) install_github("gbradburd/SpaceMix",build_vignettes=TRUE)

You can then look at the vignette with

vignette("spacemix_vignette")

and you can see all documented functions using

??SpaceMix

The citation for this paper is: Bradburd GS, Ralph PL, Coop GM (2016) A Spatial Framework for Understanding Population Structure and Admixture. PLoS Genet 12(1): e1005703

and the DOI link is below: http://dx.doi.org/10.1371/journal.pgen.1005703