diff --git a/README.md b/README.md index e9e5694..fdb63ef 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ # qqman: An R package for creating Q-Q and manhattan plots from GWAS results. +## Citation + +Turner, S.D. qqman: an R package for visualizing GWAS results using Q-Q and manhattan plots. *biorXiv* DOI: . + +Read the preprint here: xx + ## Installation Install the stable release from CRAN: ```coffee # Install once -# Note, not yet available on CRAN -# install.packages("qqman") -# library(qqman) +install.packages("qqman") + +# Load each time you use it +library(qqman) ``` Install the most recent development release with devtools (note, there be dragons here): @@ -16,7 +23,7 @@ Install the most recent development release with devtools (note, there be dragon ```coffee # Install once with devtools library(devtools) -install_github("stephenturner/qqman", ref="pkg") +install_github("stephenturner/qqman") # Load library(qqman) @@ -24,7 +31,7 @@ library(qqman) ## Usage -See the package vignette for more examples: +See the [online package vignette](http://cran.r-project.org/web/packages/qqman/vignettes/qqman.html) for more examples: ```coffee vignette("manhattan") @@ -57,7 +64,6 @@ Get help: ## Notes -* Submission to CRAN pending. * This release is substantially simplified for the sake of maintainability and creating an R package. The old code that allows confidence intervals on the Q-Q plot and allows more flexible annotation and highlighting is still available at the [version 0.0.0 tag](https://github.com/stephenturner/qqman/tree/v0.0.0). * Special thanks to Dan Capurso and Tim Knutsen for useful contributions and bugfixes. * Thanks to all the blog commenters for pointing out bugs and other issues.