Skip to content

Commit

Permalink
update readme with bioconda installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Zilong-Li committed Aug 20, 2024
1 parent 4ddc08b commit 82faa2b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ QUILT2: genotype calling from low coverage reads
<!-- badges: start -->
![Build Status](https://github.com/rwdavies/QUILT/workflows/CI/badge.svg)
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/r-quilt/README.html)
![](https://anaconda.org/bioconda/r-quilt/badges/version.svg)
![version](https://anaconda.org/bioconda/r-quilt/badges/version.svg)
<!-- badges: end -->

**__Current Version: 2.0.0__**
***Prerelease*** date: July 06, 2024
**__Current Version: 2.0.0__**. Release date: July 06, 2024

We are excited to release QUILT2, a major upgrade over QUILT (QUILT1). For details of past changes to QUILT2 and QUILT1, please see the [CHANGELOG](CHANGELOG.md).

Expand All @@ -25,6 +24,7 @@ Please use this README for general information about QUILT2. For more informatio
7. [Citation](#paragraph-citation)
8. [Testing](#paragraph-testing)
9. [Bug reports](#paragraph-bugreports)
10. [Contacts](#paragraph-contacts)


## Introduction <a name="paragraph-introduction"></a>
Expand All @@ -33,8 +33,13 @@ QUILT2 is a fast and memory-efficient method for imputation from low coverage se

## Installation <a name="paragraph-installation"></a>

QUILT2 is available to download and install through this Github repository.
QUILT2 depends on [STITCH>=1.7.0](https://github.com/rwdavies/STITCH) and [mspbwt>=0.1.0](https://github.com/rwdavies/mspbwt).
QUILT2 is available on bioconda which can be installed by

```
conda create -c bioconda -n quilt2 'r-quilt>=2.0.0'
```

Also, QUILT2 is available to download and install through this GitHub repository, which depends on [STITCH>=1.7.0](https://github.com/rwdavies/STITCH) and [mspbwt>=0.1.0](https://github.com/rwdavies/mspbwt).

```
git clone --recursive https://github.com/rwdavies/QUILT.git
Expand Down Expand Up @@ -103,5 +108,7 @@ Tests in QUILT2 are split into unit or acceptance run using ```./scripts/test-un

The best way to get help is to submit a bug report on GitHub in the [Issues](https://github.com/rwdavies/QUILT/issues) section. Please also use the Issues section if you have a more general question, such issues will be left open for others to see. Similarly, please check the issues before posting to see if your issue has already been addressed

## Contacts <a name="paragraph-contacts"></a>

For more detailed questions or other concerns please contact Robert Davies [email protected] and Zilong Li [email protected]

23 changes: 23 additions & 0 deletions maps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
The genetic map file and recombination rate
=====

[Here](hg38) we provide the genetic map files of GRCh38 coordinates using CEU recombination rate, but any population can be used, or a cross-population recombination rate. Also, we give instruction on how one can download the recombination rate of interested population and create the genetic map file that QUILT needs.


Download the genetic map file of build 37 for CEU population from the 1000 Genome Project.

```
inputs_dir="."
cd ${inputs_dir}
wget ftp-trace.ncbi.nih.gov/1000genomes/ftp/technical/working/20130507_omni_recombination_rates/CEU_omni_recombination_20130507.tar
tar -xvf CEU_omni_recombination_20130507.tar
```

In this particular case, we can use liftOver, to lift over the recombination rate from build 37, to build 38. We do that using a helper R [script](https://github.com/rwdavies/QUILT/blob/master/scripts/make_b38_recomb_map.R) available in the QUILT repository.

```
wget http://hgdownload.cse.ucsc.edu/admin/exe/linux.x86_64/liftOver
chmod +x liftOver
wget http://hgdownload.cse.ucsc.edu/goldenpath/hg19/liftOver/hg19ToHg38.over.chain.gz
R -f QUILT/scripts/make_b38_recomb_map.R --args ${inputs_dir} CEU 6
```

0 comments on commit 82faa2b

Please sign in to comment.