You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A/README.md
+25-15Lines changed: 25 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -70,45 +70,49 @@ This approach allows you to run the workflow within a containerized environment,
70
70
71
71
Singularity is a containerization platform for running applications portably and reproducibly. We use container images hosted on Quay.io to encapsulate all the necessary software and dependencies required by the GL_RefAnnotTable-A workflow. This setup allows you to run the workflow without installing any software directly on your system.
72
72
73
-
> ***Note**: Other containerization tools like Docker or Apptainer can also be used to pull and run these images.*
73
+
> **Note**: Other containerization tools like Docker or Apptainer can also be used to pull and run these images.
74
74
75
75
76
76
We recommend installing Singularity system-wide as per the official [Singularity installation documentation](https://docs.sylabs.io/guides/3.10/admin-guide/admin_quickstart.html).
77
77
78
78
79
-
> ***Note**: While Singularity is also available through [Anaconda](https://anaconda.org/conda-forge/singularity), we recommend installing Singularity system-wide following the official installation documentation.*
79
+
> **Note**: While Singularity is also available through [Anaconda](https://anaconda.org/conda-forge/singularity), we recommend installing Singularity system-wide following the official installation documentation.
80
80
81
81
<br>
82
82
83
83
#### Step 2: Fetch the Singularity Image
84
84
85
85
To pull the Singularity image needed for the workflow, you can use the provided script as directed below or pull the image directly.
86
86
87
-
> ***Note**: This command should be run in the location containing the `GL_RefAnnotTable-A_1.1.0` directory that was downloaded in [step 1](#1-download-the-workflow-files). Depending on your network speed, fetching the images will take approximately 20 minutes.*
88
-
87
+
> **Note**: This command should be run in the location containing the `GL_RefAnnotTable-A_1.1.0` directory that was downloaded in [step 1](#1-download-the-workflow-files). Depending on your network speed, fetching the images will take approximately 20 minutes.
Once complete, a `singularity` folder containing the Singularity images will be created. Run the following command to export this folder as an environment variable:
95
-
93
+
Once complete, a `singularity` folder containing the Singularity images will be created. Next, set up the required environment variables:
96
94
97
95
```bash
96
+
# Set R library path to current working directory
97
+
export R_LIBS_USER=$(pwd)/R_libs
98
+
99
+
# Set Singularity cache directory
98
100
export SINGULARITY_CACHEDIR=$(pwd)/singularity
99
101
```
100
102
101
103
<br>
102
104
103
105
#### Step 3: Run the Workflow
104
106
105
-
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder that was downloaded in [step 1](#1-download-the-workflow-files), you can now run the workflow. Below is an example for generating the annotation table for *Mus musculus* (mouse):
106
-
107
+
> **Note**: The annotation database creation process requires FTP access through port 21. If you encounter connection issues, please verify that port 21 is not blocked by your network/firewall settings or try running the workflow on a system with unrestricted FTP access.
108
+
109
+
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder that was downloaded in [step 1](#1-download-the-workflow-files), you can now run the workflow. Below is an example for generating the annotation table for *Mus musculus* (mouse):
@@ -206,12 +210,18 @@ If the reference table does not specify an annotations database for the target o
206
210
207
211
#### Using Singularity
208
212
213
+
> **Note**: The annotation database creation process requires FTP access through port 21. If you encounter connection issues, please verify that port 21 is not blocked by your network/firewall settings.
Copy file name to clipboardExpand all lines: GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A/workflow_code/GL-DPPD-7110-A_build-genome-annots-tab.R
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
# GeneLab script for generating organism-specific gene annotation tables
4
4
# Example usage: Rscript GL-DPPD-7110-A_build-genome-annots-tab.R 'Mus musculus'
5
5
options(timeout=3600)
6
-
6
+
.libPaths(Sys.getenv("R_LIBS_USER"))
7
7
# Define variables associated with current pipeline and annotation table versions
0 commit comments