Bump version: 1.2.2 → 1.2.3

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.2
+current_version = 1.2.3
 commit = True
 tag = True
 tag_name = {new_version}

Dockerfile

@@ -1,4 +1,4 @@
-ARG VERSION=1.2.2
+ARG VERSION=1.2.3
 FROM "predector/predector-base:${VERSION}"
 
 LABEL description="Docker image containing all requirements for the predector pipeline"

README.md

@@ -29,7 +29,7 @@ If you do use results of Predector in your manuscripts please also cite the depe
 Predector ranking does not replace these tools, it is designed to combine information from multiple tools in a useful way.
 We rely heavily on these tools and they should be supported with citations to enable their continued development.
 
-More details on dependencies are available in [the wiki](https://github.com/ccdmb/predector/wiki/1.2.2#how-should-i-cite-predector) and we provide a [BibTeX](http://www.bibtex.org/Format/) formatted [file with citations](https://github.com/ccdmb/predector/citations.bib), which can be imported into most citation managers.
+More details on dependencies are available in [the wiki](https://github.com/ccdmb/predector/wiki/1.2.3#how-should-i-cite-predector) and we provide a [BibTeX](http://www.bibtex.org/Format/) formatted [file with citations](https://github.com/ccdmb/predector/citations.bib), which can be imported into most citation managers.
 
 
 ## Documentation
@@ -38,12 +38,12 @@ Brief instructions are presented on this page, but extended documentation can be
 
 Quick documentation links:
 
-- [Quick install instructions](https://github.com/ccdmb/predector/wiki/1.2.2#quick-install)
-- [Extended install instructions](https://github.com/ccdmb/predector/wiki/1.2.2#extended-dependency-install-guide)
-- [Usage](https://github.com/ccdmb/predector/wiki/1.2.2#running-the-pipeline)
-- [Description of outputs](https://github.com/ccdmb/predector/wiki/1.2.2#pipeline-output)
-- [Common issues](https://github.com/ccdmb/predector/wiki/1.2.2#common-issues)
-- [FAQ](https://github.com/ccdmb/predector/wiki/1.2.2#faq)
+- [Quick install instructions](https://github.com/ccdmb/predector/wiki/1.2.3#quick-install)
+- [Extended install instructions](https://github.com/ccdmb/predector/wiki/1.2.3#extended-dependency-install-guide)
+- [Usage](https://github.com/ccdmb/predector/wiki/1.2.3#running-the-pipeline)
+- [Description of outputs](https://github.com/ccdmb/predector/wiki/1.2.3#pipeline-output)
+- [Common issues](https://github.com/ccdmb/predector/wiki/1.2.3#common-issues)
+- [FAQ](https://github.com/ccdmb/predector/wiki/1.2.3#faq)
 
 
 If you have any questions, think that some documentation is missing, or have any other suggestions or issues to report, please feel free to create an [issue](https://github.com/ccdmb/predector/issues) or start a [discussion](https://github.com/ccdmb/predector/discussions).
@@ -52,11 +52,11 @@ If you have any questions, think that some documentation is missing, or have any
 ## Install
 
 This is a quick install guide that unfortunately isn't terribly quick.
-For extended documentation and troubleshooting advice, see the [Wiki install documentation](https://github.com/ccdmb/predector/wiki/1.2.2#quick-install).
+For extended documentation and troubleshooting advice, see the [Wiki install documentation](https://github.com/ccdmb/predector/wiki/1.2.3#quick-install).
 
 Note that if you have run a previous version of the pipeline, you will need to re-build
 the software environment, as the dependencies may have changed.
-Please see the [Wiki install documentation](https://github.com/ccdmb/predector/wiki/1.2.2#optional---remove-previous-software-environments-for-old-versions-of-the-pipeline) for more details.
+Please see the [Wiki install documentation](https://github.com/ccdmb/predector/wiki/1.2.3#optional---remove-previous-software-environments-for-old-versions-of-the-pipeline) for more details.
 
 
 ### Minimal requirements
@@ -119,7 +119,7 @@ For singularity and docker container building you may be prompted for your root
 ```bash
 ENVIRONMENT=docker
 
-curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.2/install.sh" \
+curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.3/install.sh" \
 | bash -s "${ENVIRONMENT}" \
     -3 signalp-3.0.Linux.tar.Z \
     -4 signalp-4.1g.Linux.tar.gz \
@@ -131,7 +131,7 @@ curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.2/install.sh" \
     -p phobius101_linux.tar.gz
 ```
 
-This will create the conda environment (named `predector`), or the docker (tagged `predector/predector:1.2.2`) or singularity (file `./predector.sif`) containers.
+This will create the conda environment (named `predector`), or the docker (tagged `predector/predector:1.2.3`) or singularity (file `./predector.sif`) containers.
 
 **Take note of the message given upon completion**, which will tell you how to use the container or environment with predector.
 
@@ -162,25 +162,25 @@ Use one of the commands below using information given upon completion of depende
 #### Using conda
 
 ```bash
-nextflow run -profile test -with-conda /home/username/path/to/environment -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test -with-conda /home/username/path/to/environment -resume -r 1.2.3 ccdmb/predector
 ```
 
 #### Using docker
 
 ```bash
-nextflow run -profile test,docker -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,docker -resume -r 1.2.3 ccdmb/predector
 
 # if your docker configuration requires sudo use this profile instead
-nextflow run -profile test,docker_sudo -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,docker_sudo -resume -r 1.2.3 ccdmb/predector
 ```
 
 #### Using singularity
 
 ```bash
-nextflow run -profile test -with-singularity path/to/predector.sif -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test -with-singularity path/to/predector.sif -resume -r 1.2.3 ccdmb/predector
 
 # or if you've build the container using docker and it's in your local docker registry.
-nextflow run -profile test,singularity -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,singularity -resume -r 1.2.3 ccdmb/predector
 ```
 
 ## Quickstart
@@ -189,23 +189,23 @@ Say you have a set of amino-acid sequences in fasta format in the directory `pro
 The following command will run the complete analysis and the results will be available in a `results` folder.
 
 ```bash
-nextflow run -resume -r 1.2.2 ccdmb/predector --proteome "proteomes/*"
+nextflow run -resume -r 1.2.3 ccdmb/predector --proteome "proteomes/*"
 ```
 
 To improve performance I strongly recommend specifying an appropriate profile for the computer you're running the pipeline on.
-You can find information on available profiles in the [wiki documentation](https://github.com/ccdmb/predector/wiki/1.2.2#profiles-and-configuration).
+You can find information on available profiles in the [wiki documentation](https://github.com/ccdmb/predector/wiki/1.2.3#profiles-and-configuration).
 
 
 **Please note that if you have previously run a different version of the pipeline on the same computer you will need to ask Nextflow to pull the latest changes.**
-See how to do this in the [extended documentation](https://github.com/ccdmb/predector/wiki/1.2.2#running-different-pipeline-versions) and the [common issues section](https://github.com/ccdmb/predector/wiki/1.2.2#common-issues).
+See how to do this in the [extended documentation](https://github.com/ccdmb/predector/wiki/1.2.3#running-different-pipeline-versions) and the [common issues section](https://github.com/ccdmb/predector/wiki/1.2.3#common-issues).
 
 
 ## Outputs
 
 The main output of Predector is a file with the suffix `-ranked.tsv` which is a tab separated values file that can be opened in excel.
 This contains a summarised version of all of the information that you would typically need for evaluating effector protein candidates.
 
-You can find a description of all of the results in [the wiki](https://github.com/ccdmb/predector/wiki/1.2.2#pipeline-output).
+You can find a description of all of the results in [the wiki](https://github.com/ccdmb/predector/wiki/1.2.3#pipeline-output).
 
 An example set of results is available in the [`test` directory on github](https://github.com/ccdmb/predector/tree/1.2.1-beta/test/test_set_results).
 

base.Dockerfile

@@ -1,7 +1,7 @@
 FROM continuumio/miniconda3:4.10.3
 
 ENV ENVIRONMENT=predector
-ENV VERSION=1.2.2
+ENV VERSION=1.2.3
 
 LABEL maintainer="[email protected]"
 LABEL description="Docker image containing all non-proprietary requirements for the predector pipeline"

docs/install.md

@@ -85,7 +85,7 @@ For singularity and docker container building you may be prompted for your root
 ```bash
 ENVIRONMENT=docker
 
-curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.2/install.sh" \
+curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.3/install.sh" \
 | bash -s "${ENVIRONMENT}" \
     -3 signalp-3.0.Linux.tar.Z \
     -4 signalp-4.1g.Linux.tar.gz \
@@ -97,7 +97,7 @@ curl -s "https://raw.githubusercontent.com/ccdmb/predector/1.2.2/install.sh" \
     -p phobius101_linux.tar.gz
 ```
 
-This will create the conda environment (named `predector`), or the docker (tagged `predector/predector:1.2.2`) or singularity (file `./predector.sif`) containers.
+This will create the conda environment (named `predector`), or the docker (tagged `predector/predector:1.2.3`) or singularity (file `./predector.sif`) containers.
 
 **Take note of the message given upon completion**, which will tell you how to use the container or environment with Predector.
 
@@ -107,7 +107,7 @@ You can also save the install script locally and run `install.sh --help` to find
 
 ```
 -n|--name         -- For conda, sets the environment name (default: 'predector').
-                     For docker, sets the image tag (default: 'predector/predector:1.2.2').
+                     For docker, sets the image tag (default: 'predector/predector:1.2.3').
                      For singularity, sets the output image filename (default: './predector.sif').
 -c|--conda-prefix -- If set, use this as the location to store the built conda
                      environment instead of setting a name and using the default
@@ -150,25 +150,25 @@ Use one of the commands below using information given upon completion of depende
 Using conda:
 
 ```bash
-nextflow run -profile test -with-conda /home/username/path/to/environment -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test -with-conda /home/username/path/to/environment -resume -r 1.2.3 ccdmb/predector
 ```
 
 Using docker:
 
 ```bash
-nextflow run -profile test,docker -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,docker -resume -r 1.2.3 ccdmb/predector
 
 # if your docker configuration requires sudo use this profile instead
-nextflow run -profile test,docker_sudo -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,docker_sudo -resume -r 1.2.3 ccdmb/predector
 ```
 
 Using singularity:
 
 ```bash
-nextflow run -profile test -with-singularity path/to/predector.sif -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test -with-singularity path/to/predector.sif -resume -r 1.2.3 ccdmb/predector
 
 # or if you've build the container using docker and it's in your local docker registry.
-nextflow run -profile test,singularity -resume -r 1.2.2 ccdmb/predector
+nextflow run -profile test,singularity -resume -r 1.2.3 ccdmb/predector
 ```
 
 ## Extended dependency install guide
@@ -191,7 +191,7 @@ First we create the conda environment, which includes the non-proprietary depend
 
 ```bash
 # Download the environment config file.
-curl -o environment.yml https://raw.githubusercontent.com/ccdmb/predector/1.2.2/environment.yml
+curl -o environment.yml https://raw.githubusercontent.com/ccdmb/predector/1.2.3/environment.yml
 
 # Create the environment
 conda env create -f environment.yml
@@ -225,7 +225,7 @@ Modify the source `.tar` archive filenames in the command if necessary.
 Depending on how you installed docker you may need to use `sudo docker` in place of `docker`.
 
 ```bash
-curl -s https://raw.githubusercontent.com/ccdmb/predector/1.2.2/Dockerfile \
+curl -s https://raw.githubusercontent.com/ccdmb/predector/1.2.3/Dockerfile \
 | docker build \
   --build-arg SIGNALP3=signalp-3.0.Linux.tar.Z \
   --build-arg SIGNALP4=signalp-4.1g.Linux.tar.gz \
@@ -235,12 +235,12 @@ curl -s https://raw.githubusercontent.com/ccdmb/predector/1.2.2/Dockerfile \
   --build-arg PHOBIUS=phobius101_linux.tar.gz \
   --build-arg TMHMM=tmhmm-2.0c.Linux.tar.gz \
   --build-arg DEEPLOC=deeploc-1.0.All.tar.gz \
-  -t predector/predector:1.2.2 \
+  -t predector/predector:1.2.3 \
   -f - \
   .
 ```
 
-Your container should now be available as `predector/predector:1.2.2` in your docker registry `docker images`.
+Your container should now be available as `predector/predector:1.2.3` in your docker registry `docker images`.
 
 
 ### Building the Singularity container the long way
@@ -266,7 +266,7 @@ export TMHMM=tmhmm-2.0c.Linux.tar.gz
 export DEEPLOC=deeploc-1.0.All.tar.gz
 
 # Download the .def file
-curl -o ./singularity.def https://raw.githubusercontent.com/ccdmb/predector/1.2.2/singularity.def
+curl -o ./singularity.def https://raw.githubusercontent.com/ccdmb/predector/1.2.3/singularity.def
 
 # Build the .sif singularity image.
 # Note that `sudo -E` is important, it tells sudo to keep the environment variables
@@ -280,7 +280,7 @@ If you've already built the container using docker, you can convert them to sing
 You don't need to use `sudo` even if your docker installation usually requires it.
 
 ```bash
-singularity build predector.sif docker-daemon://predector/predector:1.2.2
+singularity build predector.sif docker-daemon://predector/predector:1.2.3
 ```
 
 
@@ -310,7 +310,7 @@ Docker containers can be saved as a tarball and copied wherever you like.
 
 ```bash
 # You could pipe this through gzip if you wanted.
-docker save predector/predector:1.2.2 > predector.tar
+docker save predector/predector:1.2.3 > predector.tar
 ```
 
 And on the other end

docs/output.md

@@ -9,7 +9,7 @@ Predector internally removes duplicate sequences at the start to avoid redundant
 The `deduplicated` folder contains the deduplicated sequences, results, and a mapping file of the old ids to new ones.
 
 Other directories will be named after the input filenames and each contains several tables.
-An example set of these results is available in the [`test` directory on github](https://github.com/ccdmb/predector/tree/1.2.2/test/test_set_results).
+An example set of these results is available in the [`test` directory on github](https://github.com/ccdmb/predector/tree/1.2.3/test/test_set_results).
 
 ### `deduplicated/`
 

docs/running.md

@@ -10,7 +10,7 @@ Conda:
 ```bash
 nextflow run \
   -resume \
-  -r 1.2.2 \
+  -r 1.2.3 \
   -with-conda /path/to/conda/env \
   ccdmb/predector \
   --proteome "my_proteomes/*.faa"
@@ -21,7 +21,7 @@ Docker:
 ```bash
 nextflow run \
   -resume \
-  -r 1.2.2 \
+  -r 1.2.3 \
   -profile docker \
   ccdmb/predector \
   --proteome "my_proteomes/*.faa"
@@ -32,7 +32,7 @@ Singularity:
 ```bash
 nextflow run \
   -resume \
-  -r 1.2.2 \
+  -r 1.2.3 \
   -with-singularity ./path/to/singularity.sif \
   ccdmb/predector \
   --proteome "my_proteomes/*.faa"
@@ -342,7 +342,7 @@ In the config files, you can select these tasks by label.
 
 ### Running different pipeline versions.
 
-We pin the version of the pipeline to run in all of our example commands with the `-r 1.2.2` parameter.
+We pin the version of the pipeline to run in all of our example commands with the `-r 1.2.3` parameter.
 These flags are optional, but recommended so that you know which version you ran.
 Different versions of the pipelines may output different scores, use different parameters, different output formats etc.
 It also re-enforces the link between the pipeline version and the docker container tags.
@@ -355,7 +355,7 @@ If you have previously run Predector and want to update it to use a new version,
    Likewise, you can run old versions of the pipeline by simply changing `-r`.
 
   ```
-  nextflow run -r 1.2.2 -latest ccdmb/predector --proteomes "my_proteins.fasta"
+  nextflow run -r 1.2.3 -latest ccdmb/predector --proteomes "my_proteins.fasta"
   ```
 
 2. You can ask Nextflow to pull new changes without running the pipeline using `nextflow pull ccdmb/predector`.
@@ -414,12 +414,12 @@ Here's a basic workflow using precomputed results.
 
 
 ```
-nextflow run -profile docker -resume -r 1.2.2 ccdmb/predector \
+nextflow run -profile docker -resume -r 1.2.3 ccdmb/predector \
   --proteome my_old_proteome.fasta
 
 cp -L results/deduplicated/new_results.ldjson ./precomputed.ldjson
 
-nextflow run -profile docker -resume -r 1.2.2 ccdmb/predector \
+nextflow run -profile docker -resume -r 1.2.3 ccdmb/predector \
   --proteome my_new_proteome.fasta --precomputed_ldjson ./precomputed.ldjson
 
 cat results/deduplicated/new_results.ldjson >> ./precomputed.ldjson

install.sh

@@ -8,7 +8,7 @@ REPOBASE="https://raw.githubusercontent.com/ccdmb/predector"
 DOCUMENTATION_URL="https://github.com/ccdmb/predector/wiki"
 
 ### DEFAULT PARAMETERS
-VERSION=1.2.2
+VERSION=1.2.3
 
 SIGNALP3= #signalp-3.0.Linux.tar.Z
 SIGNALP4= #signalp-4.1g.Linux.tar.gz

nextflow.config

@@ -13,7 +13,7 @@ manifest {
     description = 'A pipeline to predict effectors.'
     mainScript = 'main.nf'
     nextflowVersion = '>=21'
-    version = '1.2.2'
+    version = '1.2.3'
 }
 
 

singularity.def

@@ -1,9 +1,9 @@
 bootstrap: docker
-From: predector/predector-base:1.2.2
+From: predector/predector-base:1.2.3
 
 %labels
     Author "[email protected]"
-    Version "1.2.2"
+    Version "1.2.3"
 
 %help
     A containter will all dependencies for the predector pipeline.