Skip to content

Commit bbf7a78

Browse files
Updating install and run instructions.
1 parent eb93b05 commit bbf7a78

File tree

1 file changed

+14
-9
lines changed
  • GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A

1 file changed

+14
-9
lines changed

GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GL_RefAnnotTable Workflow Information and Usage Instructions
22

33
## General workflow info
4-
The current GeneLab Reference Annotation Table (GL_RefAnnotTable) pipeline is implemented as an R workflow that can be run from a command line interface (CLI) using bash. 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).
4+
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 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).
55

66
## Utilizing the workflow
77

@@ -32,18 +32,21 @@ Within an active R environment, run the following commands to install the requir
3232
```R
3333
install.packages("tidyverse", version = 2.0.0, repos = "http://cran.us.r-project.org")
3434

35-
install.packages("BiocManager", version = 3.19, repos = "http://cran.us.r-project.org")
35+
install.packages("BiocManager", version = 3.19.1, repos = "http://cran.us.r-project.org")
3636

37-
BiocManager::install("STRINGdb", version = 3.19)
38-
BiocManager::install("PANTHER.db", version = 3.19)
39-
BiocManager::install("rtracklayer", version = 3.19)
37+
BiocManager::install("STRINGdb", version = 3.19.1)
38+
BiocManager::install("PANTHER.db", version = 3.19.1)
39+
BiocManager::install("rtracklayer", version = 3.19.1)
40+
BiocManager::install("AnnotationForge", version = 1.46.0)
41+
BiocManager::install("biomaRt", version = 2.60.1)
42+
BiocManager::install("GO.db", version = 3.19.1)
4043
```
4144

4245
<br>
4346

4447
### 2. Download the Workflow Files
4548

46-
All files required for utilizing the GL_RefAnnotTable workflow for generating reference annotation tables are in the [workflow_code](workflow_code) directory. To get a copy of latest GL_RefAnnotTable version on to your system, run the following command:
49+
All files required for utilizing the GL_RefAnnotTable-A workflow for generating reference annotation tables are in the [workflow_code](workflow_code) directory. To get a copy of latest GL_RefAnnotTable version on to your system, run the following command:
4750

4851
```bash
4952
curl -LO https://github.com/nasa/GeneLab_Data_Processing/releases/download/GL_RefAnnotTable-A_1.1.0/GL_RefAnnotTable-A_1.1.0.zip
@@ -53,9 +56,11 @@ curl -LO https://github.com/nasa/GeneLab_Data_Processing/releases/download/GL_Re
5356

5457
### 3. Setup Execution Permission for Workflow Scripts
5558

56-
Once you've downloaded the GL_RefAnnotTable workflow directory as a zip file, unzip the workflow then `cd` into the GL_RefAnnotTable-A_1.1.0 directory on the CLI. Next, run the following command to set the execution permissions for the R script:
59+
Once you've downloaded the GL_RefAnnotTable-A workflow directory as a zip file, unzip the workflow then `cd` into the GL_RefAnnotTable-A_1.1.0 directory on the CLI. Next, run the following command to set the execution permissions for the R script:
5760

5861
```bash
62+
unzip GL_RefAnnotTable-A_1.1.0.zip
63+
cd GL_RefAnnotTable-A_1.1.0
5964
chmod -R u+x *R
6065
```
6166

@@ -94,6 +99,6 @@ Rscript install-org-db.R 'Bacillus subtilis' /path/to/GL-DPPD-7110-A_annotations
9499

95100
- The path to a local reference table must also be supplied as the second positional argument
96101

97-
Output data:
102+
**Output data:**
98103

99-
- org.*.eg.db/ (species-specific annotation database, as a local R package)
104+
- org.*.eg.db/ (species-specific annotation database, as a local R package)

0 commit comments

Comments
 (0)