Skip to content

Commit bd98e77

Browse files
author
Yaobo Xu
committed
Merge branch 'release/2.5.0'
* Added run-cgprna subcommands: `tophat-fusion`, `start-fusion` and `defuse` to run infuse pipeline. * Re-organized expected file structure in Star reference bundle. Previous Star reference bundle on the FTP server will not work for this version. * Added CWL files to run Infuse pipeline in cgpRna and example JSON files for using them with Dockstore. * Uploaded new set of reference bundle files for GRCh38 and GRCh37d5 to the FTP server. * Updated `setup.sh` to install Python3 RSeQC and HTSeq.
2 parents e8223cb + 1f89d6f commit bd98e77

34 files changed

+1664
-111
lines changed

CHANGES.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGES
22

3+
## 2.5.0
4+
5+
* Added run-cgprna subcommands: `tophat-fusion`, `start-fusion` and `defuse` to run infuse pipeline.
6+
* Re-organized expected file structure in Star reference bundle. Previous Star reference bundle on the FTP server will not work for this version.
7+
* Added CWL files to run Infuse pipeline in cgpRna and example JSON files for using them with Dockstore.
8+
* Uploaded new set of reference bundle files for GRCh38 and GRCh37d5 to the FTP server.
9+
* Updated `setup.sh` to install Python3 RSeQC and HTSeq.
10+
311
## 2.4.1
412

513
* added a patched topaht-fusion-post script, in which the contig name bug #37 is fixed

Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ FROM ubuntu:16.04
9191

9292
LABEL maintainer="[email protected]" \
9393
uk.ac.sanger.cgp="Cancer, Ageing and Somatic Mutation, Wellcome Trust Sanger Institute" \
94-
version="2.4.1" \
94+
version="2.5.0" \
9595
description="cgpRna docker"
9696

9797
# Version of tools that are installed in both stages, make sure they are consistent.
@@ -139,7 +139,7 @@ RUN locale-gen en_US.UTF-8
139139
RUN update-locale LANG=en_US.UTF-8
140140

141141
ENV OPT /opt/wtsi-cgp
142-
ENV PATH $OPT/bin:$OPT/biobambam2/bin:$OPT/python-lib/bin/:$PATH
142+
ENV PATH $OPT/bin:$OPT/biobambam2/bin:$OPT/python-lib/bin:$PATH
143143
ENV PERL5LIB $OPT/lib/perl5
144144
ENV R_LIBS $OPT/R-lib
145145
ENV R_LIBS_USER $R_LIBS

README.md

+25-14
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,49 @@
11
# cgpRna
22

3-
[![Quay Badge][quay-status]][quay-repo]
4-
53
| Master | Develop |
64
| --------------------------------------------- | ----------------------------------------------- |
75
| [![Master Badge][travis-master]][travis-base] | [![Develop Badge][travis-develop]][travis-base] |
86

97
cgpRna provides pipelines, for RNA-Seq data, that implement commonly used mapping
108
and analysis programs, such as TopHat and rna-star.
119
At the present time (May 2016), only pipelines for mapping (with STAR), lane QC
12-
and fusion gene detection are included in this codebase but this will be added
13-
to over time with; differential expression, gene/transcript quantification, splice
14-
variant analysis and allele specific expression.
10+
and fusion gene detection is included in this codebase.
11+
12+
## Docker container
13+
14+
cgpRna is available as a Docker container on [Quay.io][quay-repo].
15+
16+
[![Quay Badge][quay-status]][quay-repo]
17+
18+
## Workflows on Dockstore
19+
20+
Due to an [issue](https://github.com/dockstore/dockstore/issues/2923) of Dockstore, we have not registered any of the workflows in `cwl` folder, as inputs of two of them are using two-dimensional arrays. Once the issue is resolved, we'll test our workflows with the newer release of Dockstore, register our workflows and list their registries here.
1521

1622
## Dependencies and Installation
1723

18-
Please install Perl packages:
24+
If you want to install cgpRna locally, you'll need to follow the instructions below, however, we recommend to use the Docker container.
25+
26+
### Dependencies
27+
28+
cgpRna depends on these Perl packages, so they need to be installed first:
1929

2030
* [PCAP-core](https://github.com/ICGC-TCGA-PanCancer/PCAP-core/releases)
2131
* [VAGrENT](https://github.com/cancerit/VAGrENT/releases)
2232
* [cgpVcf](https://github.com/cancerit/cgpVcf/releases)
23-
* [Grass](https://github.com/cancerit/grass/releases) first.
33+
* [Grass](https://github.com/cancerit/grass/releases)
34+
35+
Note: samtools is also a dependency but this is installed by PCAP-Core.
2436

25-
Prerequisites for the [RSeQC](http://rseqc.sourceforge.net/#installation) software are:
37+
cgpRna uses [RSeQC](http://rseqc.sourceforge.net/#installation) and its prerequisites are:
2638

2739
* gcc
28-
* [python2.7](https://www.python.org/downloads/)
29-
* The minimum version the pipeline has been tested with is python-2.7.6
40+
* [python3](https://www.python.org/downloads/) and pip3 executable.
3041
* [R](https://www.r-project.org/)
3142
* [numpy](http://www.numpy.org/)
3243

33-
Once that is done and your $PATH environment variable has been updated so that newly installed
34-
software can be found, run the following to install cgpRna:
44+
### Installation
45+
46+
Once dependencies mentioned above are installed, run the following to install cgpRna:
3547

3648
```
3749
./setup.sh path_to_install_to
@@ -53,7 +65,6 @@ N.B. the path_to_install_to should be the same as the install location used for
5365
* [bedtools](https://github.com/arq5x/bedtools2/) Unless already in the install location bin directory
5466
* [blastn](http://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD=Web&PAGE_TYPE=BlastDocs&DOC_TYPE=Download) Used by tophat-fusion post
5567
* [HTSeq](https://pypi.python.org/packages/3c/6e/f8dc3500933e036993645c3f854c4351c9028b180c6dcececde944022992/HTSeq-0.6.1p1.tar.gz) used for read counting
56-
N.B. samtools is also a dependency but this is installed by PCAP-Core which should have already been installed (see above).
5768

5869
If you are planning to use the fusion pipeline, specifically defuse_fusion.pl, the deFuse config.txt
5970
file will need to be updated with the installed locations of a number of tools.
@@ -63,7 +74,7 @@ the locations and update the file as instructed.
6374
## LICENCE
6475

6576
```
66-
Copyright (c) 2014-2017 Genome Research Ltd.
77+
Copyright (c) 2014-2019 Genome Research Ltd.
6778
6879
Author: Cancer Genome Project <[email protected]>
6980

0 commit comments

Comments
 (0)