Merge pull request nf-core#307 from nf-core/stablish-deeparg

Fix deepARG test profile and use more stable deepARG db URL
Darcy220606 · Aug 25, 2023 · 342b848 · 342b848
2 parents ae78dad + bc4db0d
commit 342b848
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 29 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -72,31 +72,31 @@ jobs:
         run: |
           nextflow run ${GITHUB_WORKSPACE} -profile test_bgc,docker --outdir ./results ${{ matrix.parameters }}
 
-  # test_deeparg: #Tests switched off as long as DeepARG servers are unavaiable for database download.
-  #   name: Run pipeline with test data (DeepARG only workflow)
-  #   # Only run on push if this is the nf-core dev branch (merged PRs)
-  #   if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/funcscan') }}"
-  #   runs-on: ubuntu-latest
-  #   strategy:
-  #     matrix:
-  #       NXF_VER:
-  #         - "23.04.0"
-  #         - "latest-everything"
-  #       parameters:
-  #         - "--annotation_tool bakta --annotation_bakta_db_downloadtype light"
-  #         - "--annotation_tool prodigal"
-  #         - "--annotation_tool prokka"
-  #         - "--annotation_tool pyrodigal"
+  test_deeparg:
+    name: Run pipeline with test data (DeepARG only workflow)
+    # Only run on push if this is the nf-core dev branch (merged PRs)
+    if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/funcscan') }}"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        NXF_VER:
+          - "23.04.0"
+          - "latest-everything"
+        parameters:
+          - "--annotation_tool bakta --annotation_bakta_db_downloadtype light"
+          - "--annotation_tool pyrodigal"
 
-  #   steps:
-  #     - name: Check out pipeline code
-  #       uses: actions/checkout@v2
+    steps:
+      - name: Check out pipeline code
+        uses: actions/checkout@v2
 
-  #     - name: Install Nextflow
-  #       uses: nf-core/setup-nextflow@v1
-  #       with:
-  #         version: "${{ matrix.NXF_VER }}"
+      - name: Install Nextflow
+        uses: nf-core/setup-nextflow@v1
+        with:
+          version: "${{ matrix.NXF_VER }}"
 
-  #     - name: Run pipeline with test data (DeepARG workflow)
-  #       run: |
-  #         nextflow run ${GITHUB_WORKSPACE} -profile test_deeparg,docker --outdir ./results ${{ matrix.parameters }}
+      - name: Run pipeline with test data (DeepARG workflow)
+        run: |
+          wget https://zenodo.org/record/8280582/files/deeparg.zip ## download from zenodo due to instability of deepARG server
+          unzip deeparg.zip
+          nextflow run ${GITHUB_WORKSPACE} -profile test_deeparg,docker --outdir ./results ${{ matrix.parameters }} --arg_deeparg_data 'deeparg/'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### `Fixed`
 
+- [#307](https://github.com/nf-core/funcscan/pull/307) Fixed stability of deepARG tests by using Zenodo copy of database (❤️ to Gustavo Arango and Liqing Zhang for uploading, fix by @jfy133)
+
 ### `Dependencies`
 
 ### `Deprecated`

diff --git a/conf/test_deeparg.config b/conf/test_deeparg.config
@@ -30,8 +30,9 @@ params {
     arg_skip_fargene       = true
     arg_skip_rgi           = true
     arg_skip_amrfinderplus = true
+    arg_skip_abricate      = true
     arg_skip_deeparg       = false
 
-    run_amp_screening = false
-    run_bgc_screening = false
+    run_amp_screening      = false
+    run_bgc_screening      = false
 }
diff --git a/docs/usage.md b/docs/usage.md
@@ -185,9 +185,10 @@ You can either:
 1. Install DeepARG from [bioconda](https://bioconda.github.io/recipes/deeparg/README.html?highlight=deeparg)
 2. Run `deeparg download_data -o /<path>/<to>/<database_location>/`
 
-Or
+Or download the files directly from
 
-1. Download the files directly from the [DeepARG FTP site](https://bench.cs.vt.edu/ftp/data/gustavo1/deeparg/database/)
+1. the [DeepARG FTP site](https://bench.cs.vt.edu/ftp/data/gustavo1/deeparg/database/)
+2. the [DeepARG database Zenodo archive](https://zenodo.org/record/8280582)
 
 Note that more recent database versions maybe available from the [ARGMiner service](https://bench.cs.vt.edu/argminer/#/home).