Skip to content

Commit 75dd660

Browse files
Typo and link fixes
1 parent 499538d commit 75dd660

File tree

1 file changed

+16
-10
lines changed
  • GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A

1 file changed

+16
-10
lines changed

GeneLab_Reference_Annotations/Workflow_Documentation/GL_RefAnnotTable-A/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
- [Step 1: Install Singularity](#step-1-install-singularity)
1111
- [Step 2: Fetch the Singularity Image](#step-2-fetch-the-singularity-image)
1212
- [Step 3: Run the Workflow](#step-3-run-the-workflow)
13-
- [Optional: Run the Annotations Database Creation Function as a Stand-Alone Script](#optional-run-the-annotations-database-creation-function-as-a-stand-alone-script)
13+
- [Optional: Run the Annotations Database Creation Function as a Stand-Alone Script via Singularity](#optional-run-the-annotations-database-creation-function-as-a-stand-alone-script-via-singularity)
1414
- [Approach 2: Using a Local R Environment](#approach-2-using-a-local-r-environment)
1515
- [Step 1: Install R and Required R Packages](#step-1-install-r-and-required-r-packages)
1616
- [Step 2: Run the Workflow](#step-2-run-the-workflow)
17-
- [Optional: Run the Annotations Database Creation Function as a Stand-Alone Script](#optional-run-the-annotations-database-creation-function-as-a-stand-alone-script)
17+
- [Optional: Run the Annotations Database Creation Function as a Stand-Alone Script via R](#optional-run-the-annotations-database-creation-function-as-a-stand-alone-script-via-r)
1818

1919
<br>
2020

@@ -111,19 +111,21 @@ Rscript /work/GL-DPPD-7110-A_build-genome-annots-tab.R 'Mus musculus'
111111

112112
- 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.
113113
> **Notes**:
114-
> - To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
115-
> - 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)
114+
> - To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
115+
> - 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)
116+
116117
- *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.
117118

118119

119120
**Output data:**
120121

121122
- *-GL-annotations.tsv (Tab delineated table of gene annotations)
123+
122124
- *-GL-build-info.txt (Text file containing information used to create the annotation table, including tool and tool versions and date of creation)
123125

124126
<br>
125127

126-
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script
128+
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script via Singularity
127129

128130
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:
129131

@@ -139,7 +141,8 @@ Rscript /work/install-org-db.R 'Bacillus subtilis'
139141
**Input data:**
140142

141143
- 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.
142-
> **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)
144+
> **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)
145+
143146
- *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.
144147

145148

@@ -208,19 +211,21 @@ Rscript GL_RefAnnotTable-A_1.1.0/GL-DPPD-7110-A_build-genome-annots-tab.R 'Mus m
208211

209212
- 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.
210213
> **Notes**:
211-
> - To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
212-
> - 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)
214+
> - To see a list of all available organisms, run `Rscript GL-DPPD-7110-A_build-genome-annots-tab.R` without positional arguments.
215+
> - 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)
216+
213217
- *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.
214218

215219

216220
**Output data:**
217221

218222
- *-GL-annotations.tsv (Tab delineated table of gene annotations)
223+
219224
- *-GL-build-info.txt (Text file containing information used to create the annotation table, including tool and tool versions and date of creation)
220225

221226
<br>
222227

223-
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script
228+
#### *Optional*: Run the Annotations Database Creation Function as a Stand-Alone Script via R
224229

225230
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:
226231

@@ -234,7 +239,8 @@ Rscript GL_RefAnnotTable-A_1.1.0/install-org-db.R 'Bacillus subtilis'
234239
**Input data:**
235240

236241
- 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.
237-
> **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)
242+
> **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)
243+
238244
- *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.
239245

240246

0 commit comments

Comments
 (0)