diff --git a/README.md b/README.md index c4532b3..9200d2d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Perform fast queries in R against a massive database of complete GWAS summary data -[![Lifecycle: -experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![R build status](https://github.com/MRCIEU/ieugwasr/workflows/R-CMD-check/badge.svg)](https://github.com/MRCIEU/ieugwasr/actions) +[![CRAN status](https://www.r-pkg.org/badges/version/ieugwasr)](https://CRAN.R-project.org/package=ieugwasr) +[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) -The [IEU GWAS database](https://gwas.mrcieu.ac.uk/) comprises over 10,000 curated, QC'd and harmonised complete GWAS summary datasets and can be queried using an API. See [here](https://gwas-api.mrcieu.ac.uk/docs) for documentation on the API itself. This R package is a wrapper to make generic calls to the API, plus convenience functions for specific queries. +The [OpenGWAS database](https://gwas.mrcieu.ac.uk/) comprises over 50,000 curated, QC'd and harmonised complete GWAS summary datasets and can be queried using an API. See [here](https://api.opengwas.io/api/) for documentation on the API itself. This R package is a wrapper to make generic calls to the API, plus convenience functions for specific queries. Methods currently implemented: @@ -22,12 +22,18 @@ There are a few convenience functions also: - Perform LD clumping using the server, or locally - Obtain LD matrices for a list of SNPs using the server or locally (e.g. for fine mapping, colocalisation or Mendelian randomization) -See https://github.com/MRCIEU/gwasglue for information about how to connect the genotype and LD data to other packages involving colocalisation, finemapping, visualisation and MR. +See https://github.com/MRCIEU/gwasglue2 for information about how to connect the genotype and LD data to other packages involving colocalisation, finemapping, visualisation and MR. ## Installation -You can install the developer version of ieugwasr with: +Install from CRAN using: + +```r +install.packages("ieugwasr") +``` + +or install the developer version of ieugwasr with: ``` r remotes::install_github("mrcieu/ieugwasr") diff --git a/docs/404.html b/docs/404.html index d0f8b20..f699272 100644 --- a/docs/404.html +++ b/docs/404.html @@ -4,117 +4,94 @@ - +