Constrain synapser version

.github/workflows/R-CMD-check.yaml

@@ -46,12 +46,19 @@ jobs:
           extra-packages: any::rcmdcheck
           needs: check
 
-      - name: If source build fails on macOS or Windows, fall back to typical install
-        if: steps.install-deps.outcome == 'failure'
+      - name: Install working version for macOS
+        if: steps.install-deps.outcome == 'failure' && runner.os == 'macOS'
         shell: Rscript {0}
         run: |
           reticulate::install_miniconda()
-          install.packages("synapser", repos="http://ran.synapse.org")
+          install.packages("https://github.com/Sage-Bionetworks/synapser/archive/refs/tags/1.3.0.tar.gz", repos=NULL)
+
+      - name: Install working version for Windows
+        if: steps.install-deps.outcome == 'failure' && runner.os == 'Windows'
+        shell: Rscript {0}
+        run: |
+          reticulate::install_miniconda()
+          install.packages("https://github.com/Sage-Bionetworks/synapser/archive/refs/tags/1.3.0.zip", repos=NULL)
 
       - uses: r-lib/actions/check-r-package@v2
         with:

DESCRIPTION

@@ -41,7 +41,8 @@ Imports:
     plyr,
     readxl,
     yaml,
-    synapser (>= 1.0.0)
+    synapser (>= 1.0.0),
+    synapser (< 2.0.0)
 URL: https://github.com/nf-osi/nfportalutils
 BugReports: https://github.com/nf-osi/nfportalutils/issues
 Suggests: 
@@ -52,4 +53,4 @@ Suggests:
 Config/testthat/edition: 2
 VignetteBuilder: knitr
 Remotes:  
-    github::Sage-Bionetworks/synapser
+    github::Sage-Bionetworks/synapser@1.3.0

README.md

@@ -14,6 +14,10 @@ Currently, `develop` branch is default so package install and docs refer to code
 > Currently, the package is in a refactoring period where usage is complex because of the coexistence of both `synapser` and separate `synapseclient` import.
 > This will be updated when everything is 100% refactored to `synapser`. 
 
+> [!NOTE]
+> Underlying dependencies tested for this package are `synapser==1.3.0` and `synapseclient==3.1.1`.
+> There are known breaking issues for MacOS and Windows with the newer versions for now.
+
 ## Docs
 
 :point_right: [Package documentation!](https://nf-osi.github.io/nfportalutils/)