Skip to content

Commit

Permalink
update readme with CRAN details
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenturner committed May 13, 2014
1 parent 8be6fd9 commit 93bc18b
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,37 @@
# 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):

```coffee
# Install once with devtools
library(devtools)
install_github("stephenturner/qqman", ref="pkg")
install_github("stephenturner/qqman")

# Load
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")
Expand Down Expand Up @@ -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.

0 comments on commit 93bc18b

Please sign in to comment.