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
+80-44Lines changed: 80 additions & 44 deletions
Original file line number
Diff line number
Diff line change
@@ -16,25 +16,20 @@
16
16
-[Step 2: Run the Workflow](#step-2-run-the-workflow)
17
17
-[Step 3: Run the Annotations Database Creation Function as a Stand-Alone Script](#step-3-run-the-annotations-database-creation-function-as-a-stand-alone-script)
18
18
19
+
<br>
20
+
19
21
---
20
22
21
23
## General Workflow Information
22
24
23
25
The current GeneLab Reference Annotation Table (GL_RefAnnotTable-A) pipeline is implemented as an R workflow that can be run from a command line interface (CLI) using bash. The workflow can be executed using either a Singularity container or a local R environment. The workflow can be used even if you are unfamiliar with R, but if you want to learn more about R, visit the [R-project about page here](https://www.r-project.org/about.html). Additionally, an introduction to R along with installation help and information about using R for bioinformatics can be found [here at Happy Belly Bioinformatics](https://astrobiomike.github.io/R/basics).
24
26
27
+
<br>
28
+
25
29
---
26
30
27
31
## Utilizing the Workflow
28
32
29
-
To utilize the GL_RefAnnotTable-A workflow, follow the instructions below to download the necessary workflow files. Once downloaded, the workflow can be executed using two approaches:
The GL_RefAnnotTable-A workflow can be run using two approaches:
48
+
The GL_RefAnnotTable-A workflow can be run using one of two approaches:
52
49
53
50
-**[Approach 1: Using Singularity](#approach-1-using-singularity)**
54
51
-**[Approach 2: Using a Local R Environment](#approach-2-using-a-local-r-environment)**
55
52
53
+
Please follow the instructions for the approach that best matches your setup and preferences. Each method is explained in detail below.
54
+
56
55
---
57
56
58
-
####Approach 1: Using Singularity
57
+
### Approach 1: Using Singularity
59
58
60
59
This approach allows you to run the workflow within a containerized environment, ensuring consistency and reproducibility.
61
60
62
-
#####Step 1: Install Singularity
61
+
#### Step 1: Install Singularity
63
62
64
-
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. Other containerization tools like Docker or Apptainer can also be used to pull and run these images.
63
+
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.
64
+
> ***Note**: Other containerization tools like Docker or Apptainer can also be used to pull and run these images.*
65
65
66
66
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).
67
67
68
-
> **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.
68
+
> ***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.*
69
69
70
-
##### Step 2: Fetch the Singularity Image
70
+
<br>
71
+
72
+
#### Step 2: Fetch the Singularity Image
71
73
72
74
To pull the Singularity image needed for the workflow, you can use the provided script as directed below or pull the image directly.
73
75
74
-
> **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.
76
+
> ***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:
82
+
83
+
Once complete, a `singularity` folder containing the Singularity images will be created. Run the following command to export this folder as an environment variable:
84
+
81
85
82
86
```bash
83
87
export SINGULARITY_CACHEDIR=$(pwd)/singularity
84
88
```
89
+
<br>
85
90
86
-
#####Step 3: Run the Workflow
91
+
#### Step 3: Run the Workflow
87
92
88
-
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder, you can now run the workflow. Below is an example for generating the annotation table for *Mus musculus* (mouse):
93
+
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder, you can now run the workflow. Below is an example for generating the annotation table for *Mus musculus* (mouse):
- No input files are required. Specify the target organism using a positional command line argument. `Mus musculus` is used in the example above. To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments. The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
99
-
- Optional: a reference table CSV can be supplied as a second positional argument instead of using the default [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
104
+
- No input files are required. Specify the species name of the target organism using a positional command line argument. `Mus musculus` is used in the example above.
105
+
> **Notes**:
106
+
> To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
107
+
> The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
108
+
-*Optional*: A local reference table CSV file can be supplied as a second positional argument. If not provided, the script will download the current version of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) table by default.
109
+
100
110
101
111
**Output data:**
102
112
103
113
-*-GL-annotations.tsv (Tab delineated table of gene annotations)
104
114
-*-GL-build-info.txt (Text file containing information used to create the annotation table, including tool and tool versions and date of creation)
105
115
106
-
##### Step 4: Run the Annotations Database Creation Function as a Stand-Alone Script
116
+
<br>
117
+
118
+
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script
107
119
108
-
If the reference table does not specify an annotations database for the target organism in the 'annotations' column, the `install_annotations` function (defined in `install-org-db.R`) will be executed. This function can also be run as a stand-alone script:
120
+
If the reference table does not specify an annotations database for the target organism in the 'annotations' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) file, the `install_annotations` function (defined in `install-org-db.R`) will be executed by default. This function can also be run as a stand-alone script:
- The target organism must be specified as the first positional command line argument. `Bacillus subtilis` is used in the example above. The correct argument for each organism can be found in the 'species' column of [GL-DPPD-7110-A_annotations.csv](https://raw.githubusercontent.com/nasa/GeneLab_Data_Processing/master/GeneLab_Reference_Annotations/Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
119
-
- Optional: A local reference table can be supplied as a second positional argument. If not provided, the script will download the current version of GL-DPPD-7110-A_annotations.csv from Github by default.
132
+
- The species name of the target organism must be specified as the first positional command line argument. `Bacillus subtilis` is used in the example above.
133
+
> **Note**: The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
134
+
-*Optional*: A local reference table CSV file can be supplied as a second positional argument. If not provided, the script will download the current version of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) table by default.
135
+
120
136
121
137
**Output data:**
122
138
123
139
- org.*.eg.db/ (Species-specific annotation database, as a local R package)
124
140
141
+
<br>
142
+
125
143
---
126
144
127
-
####Approach 2: Using a Local R Environment
145
+
### Approach 2: Using a Local R Environment
128
146
129
147
This approach allows you to run the workflow directly in your local R environment without using containers.
130
148
131
-
#####Step 1: Install R and Required R Packages
149
+
#### Step 1: Install R and Required R Packages
132
150
133
151
We recommend installing R via the [Comprehensive R Archive Network (CRAN)](https://cran.r-project.org/):
134
152
135
153
1. Select the [CRAN Mirror](https://cran.r-project.org/mirrors.html) closest to your location.
154
+
136
155
2. Navigate to the download page for your operating system.
137
-
3. Download and install R (e.g., R-4.4.0).
156
+
157
+
3. Download and install R (e.g., R-4.4.0).
138
158
139
-
Once R is installed, you need to install the required R packages.
159
+
Once R is installed, install the required R packages as follows:
140
160
141
-
Open a terminal and start R:
161
+
Open a terminal and start R:
162
+
142
163
143
164
```bash
144
165
R
145
-
```
166
+
```
146
167
147
-
Within the R environment, run the following commands to install the required packages:
168
+
169
+
Within the R environment, run the following commands to install the required packages:
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder, you can now run the workflow. Below is an example of how to run the workflow to build an annotation table for *Mus musculus* (mouse):
185
+
#### Step 2: Run the Workflow
186
+
187
+
While in the directory containing the `GL_RefAnnotTable-A_1.1.0` folder, you can now run the workflow. Below is an example of how to run the workflow to build an annotation table for *Mus musculus* (mouse):
- No input files are required. Specify the target organism using a positional command line argument. `Mus musculus` is used in the example above. To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments. The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
171
-
- Optional: a reference table CSV can be supplied as a second positional argument instead of using the default [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
197
+
- No input files are required. Specify the species name of the target organism using a positional command line argument. `Mus musculus` is used in the example above.
198
+
> **Notes**:
199
+
> To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
200
+
> The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
201
+
-*Optional*: A local reference table CSV file can be supplied as a second positional argument. If not provided, the script will download the current version of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) table by default.
202
+
172
203
173
204
**Output data:**
174
205
175
206
-*-GL-annotations.tsv (Tab delineated table of gene annotations)
176
207
-*-GL-build-info.txt (Text file containing information used to create the annotation table, including tool and tool versions and date of creation)
177
208
178
-
##### Step 3: Run the Annotations Database Creation Function as a Stand-Alone Script
209
+
<br>
210
+
211
+
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script
179
212
180
-
If the reference table does not specify an annotations database for the target organism in the 'annotations' column, the `install_annotations` function (defined in `install-org-db.R`) will be executed. This function can also be run as a stand-alone script:
213
+
If the reference table does not specify an annotations database for the target organism in the 'annotations' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) file, the `install_annotations` function (defined in `install-org-db.R`) will be executed by default. This function can also be run as a stand-alone script:
- The target organism must be specified as the first positional command line argument. `Bacillus subtilis` is used in the example above. The correct argument for each organism can be found in the 'species' column of [GL-DPPD-7110-A_annotations.csv](https://raw.githubusercontent.com/nasa/GeneLab_Data_Processing/master/GeneLab_Reference_Annotations/Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
189
-
- Optional: A local reference table can be supplied as a second positional argument. If not provided, the script will download the current version of GL-DPPD-7110-A_annotations.csv from Github by default.
222
+
- The species name of the target organism must be specified as the first positional command line argument. `Bacillus subtilis` is used in the example above.
223
+
> **Note**: The correct argument for each organism can also be found in the 'species' column of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv)
224
+
-*Optional*: A local reference table CSV file can be supplied as a second positional argument. If not provided, the script will download the current version of the [GL-DPPD-7110-A_annotations.csv](../../Pipeline_GL-DPPD-7110_Versions/GL-DPPD-7110-A/GL-DPPD-7110-A_annotations.csv) table by default.
225
+
190
226
191
227
**Output data:**
192
228
193
-
- org.*.eg.db/ (species-specific annotation database, as a local R package)
229
+
- org.*.eg.db/ (Species-specific annotation database, as a local R package)
0 commit comments