diff --git a/Dockerfile b/Dockerfile index 19cafb1..7036896 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ apt-get install -y --no-install-recommends build-essential samtools r-base rna-s Rscript -e 'install.packages("circlize", repos="http://cran.r-project.org"); source("https://bioconductor.org/biocLite.R"); biocLite(c("GenomicRanges", "GenomicAlignments"))' # install arriba -RUN wget -q -O - "https://github.com/suhrig/arriba/releases/download/v1.1.0/arriba_v1.1.0.tar.gz" | tar -xzf - +RUN wget -q -O - "https://github.com/suhrig/arriba/releases/download/v1.2.0/arriba_v1.2.0.tar.gz" | tar -xzf - # make wrapper script for download_references.sh RUN echo '#!/bin/bash\n\ diff --git a/LICENSE b/LICENSE index 75c9601..671a53b 100644 --- a/LICENSE +++ b/LICENSE @@ -4,7 +4,7 @@ License of arriba (code & executable), documentation, and database files: The MIT/Expat License -Copyright (C) 2016-2019 Sebastian Uhrig (s.uhrig@dkfz.de) +Copyright (C) 2016-2020 Sebastian Uhrig (s.uhrig@dkfz.de) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/documentation/quickstart.md b/documentation/quickstart.md index 7c0603a..72a9d1d 100644 --- a/documentation/quickstart.md +++ b/documentation/quickstart.md @@ -6,9 +6,9 @@ Arriba has only a single prerequisite: [STAR](https://github.com/alexdobin/STAR) Compile the latest stable version of Arriba or use the precompiled binaries in the download file. **Note: You should not use `git clone` to download Arriba, because the git repository does not include the blacklist! Instead, download the latest tarball from the [releases page](https://github.com/suhrig/arriba/releases/) as shown here:** ```bash -wget https://github.com/suhrig/arriba/releases/download/v1.1.0/arriba_v1.1.0.tar.gz -tar -xzf arriba_v1.1.0.tar.gz -cd arriba_v1.1.0 && make # or use precompiled binaries +wget https://github.com/suhrig/arriba/releases/download/v1.2.0/arriba_v1.2.0.tar.gz +tar -xzf arriba_v1.2.0.tar.gz +cd arriba_v1.2.0 && make # or use precompiled binaries ``` Arriba requires an assembly in FastA format, gene annotation in GTF format, and a STAR index built from the two. You can use your preferred assembly and annotation, as long as their coordinates are compatible with hg19/hs37d5/GRCh37 or hg38/GRCh38. Support for mm10 is in development. If you use another assembly, then the coordinates in the blacklist will not match and the predictions will contain many false positives. GENCODE annotation is recommended over RefSeq due to more comprehensive annotation of splice-sites, which improves sensitivity. If you do not already have the files and a STAR index, you can use the script `download_references.sh`. It downloads the files to the current working directory and builds a STAR index. Run the script without arguments to see a list of available files. Note that this step requires ~30 GB of RAM and 8 cores (or whatever number of cores you pass as the second argument). @@ -33,7 +33,7 @@ Install [Docker](https://www.docker.com/) according to the developers' instructi Run the script `download_references.sh` inside the Docker container. It downloads the assembly and gene annotation to the directory `/path/to/references` and builds a STAR index. Run the script without arguments to see a list of available files. Note that this step requires ~30 GB of RAM and 8 cores (or whatever number of cores you pass as the second argument). ```bash -docker run --rm -v /path/to/references:/references uhrigs/arriba:1.1.0 download_references.sh hs37d5+GENCODE19 +docker run --rm -v /path/to/references:/references uhrigs/arriba:1.2.0 download_references.sh hs37d5+GENCODE19 ``` Use the following Docker command to run Arriba from the container. Replace `/path/to/` with the path to the respective input file. Leave the paths after the colons unmodified - these are the paths inside the Docker container. @@ -44,7 +44,7 @@ docker run --rm \ -v /path/to/references:/references:ro \ -v /path/to/read1.fastq.gz:/read1.fastq.gz:ro \ -v /path/to/read2.fastq.gz:/read2.fastq.gz:ro \ - uhrigs/arriba:1.1.0 \ + uhrigs/arriba:1.2.0 \ arriba.sh ``` @@ -57,7 +57,7 @@ The Docker container is compatible with Singularity. If desired, it can be conve ```bash mkdir /path/to/references -singularity exec -B /path/to/references:/references docker://uhrigs/arriba:1.1.0 download_references.sh hs37d5+GENCODE19 +singularity exec -B /path/to/references:/references docker://uhrigs/arriba:1.2.0 download_references.sh hs37d5+GENCODE19 ``` Use the following Singularity command to run Arriba from the container. Replace `/path/to/` with the path to the respective input file. Leave the paths after the colons unmodified - these are the paths inside the Singularity container. @@ -68,7 +68,7 @@ singularity exec \ -B /path/to/references:/references:ro \ -B /path/to/read1.fastq.gz:/read1.fastq.gz:ro \ -B /path/to/read2.fastq.gz:/read2.fastq.gz:ro \ - docker://uhrigs/arriba:1.1.0 \ + docker://uhrigs/arriba:1.2.0 \ arriba.sh ``` @@ -80,7 +80,7 @@ Install [Miniconda](https://conda.io/) according to the developers' instructions Install the `arriba` package: ```bash -conda install -c conda-forge -c bioconda arriba=1.1.0 +conda install -c conda-forge -c bioconda arriba=1.2.0 ``` Run the scripts `download_references.sh` and `run_arriba.sh` as explained in the [manual installation instructions](#manual-installation). The blacklists are located in `$CONDA_PREFIX/var/lib/arriba`. diff --git a/documentation/visualization.md b/documentation/visualization.md index cb3cc16..9f411c5 100644 --- a/documentation/visualization.md +++ b/documentation/visualization.md @@ -65,7 +65,7 @@ docker run --rm \ -v /path/to/fusions.tsv:/fusions.tsv:ro \ -v /path/to/Aligned.sortedByCoord.out.bam:/Aligned.sortedByCoord.out.bam:ro \ -v /path/to/Aligned.sortedByCoord.out.bam.bai:/Aligned.sortedByCoord.out.bam.bai:ro \ - uhrigs/arriba:1.1.0 \ + uhrigs/arriba:1.2.0 \ draw_fusions.sh ``` @@ -80,7 +80,7 @@ singularity exec \ -B /path/to/fusions.tsv:/fusions.tsv:ro \ -B /path/to/Aligned.sortedByCoord.out.bam:/Aligned.sortedByCoord.out.bam:ro \ -B /path/to/Aligned.sortedByCoord.out.bam.bai:/Aligned.sortedByCoord.out.bam.bai:ro \ - docker://uhrigs/arriba:1.1.0 \ + docker://uhrigs/arriba:1.2.0 \ draw_fusions.sh ``` diff --git a/source/options.hpp b/source/options.hpp index e640128..559a8e9 100644 --- a/source/options.hpp +++ b/source/options.hpp @@ -10,7 +10,7 @@ using namespace std; const string HELP_CONTACT = "https://github.com/suhrig/arriba/"; const string MANUAL_URL = "https://arriba.readthedocs.io/"; -const string ARRIBA_VERSION = "1.1.0"; +const string ARRIBA_VERSION = "1.2.0"; string wrap_help(const string& option, const string& text, const unsigned short int max_line_width = 80);