Skip to content

Commit 35975a6

Browse files
Fixing typos, broken links, and adding additional instructions.
1 parent 9f03919 commit 35975a6

File tree

1 file changed

+27
-6
lines changed
  • Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations

1 file changed

+27
-6
lines changed

Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations/README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
## General info <!-- omit in toc -->
5-
The documentation for this script and its outputs can be found in [sections 6-10 of the GL-DPPD-7104-B.md processing protocol](/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#6-amplicon-seq-data-analysis-set-up). This script is automatically executed as an optional step of the SW_AmpIllumina-B Snakemake workflow when the `run_workflow.py` argument `--visualizations TRUE` is used. Alternatively, the script can be executed manually as detailed below.
5+
The documentation for this script and its outputs can be found in steps 6-10 of the [GL-DPPD-7104-B.md](https://github.com/nasa/GeneLab_Data_Processing/blob/master/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md) pipeline document. This script is automatically executed as an optional step of the [SW_AmpIllumina-B](../../) Snakemake workflow when the `run_workflow.py` argument, `--visualizations TRUE`, is used. Alternatively, the script can be executed independently as detailed below.
66

77
<br>
88

@@ -11,7 +11,7 @@ The documentation for this script and its outputs can be found in [sections 6-10
1111
## Utilizing the script <!-- omit in toc -->
1212

1313

14-
- [1. Set up the execution environment](#1-run-the-workflow-using-run_workflowpy)
14+
- [1. Set up the execution environment](#1-set-up-the-execution-environment)
1515
- [2. Run the visualization script manually](#2-run-the-visualization-script-manually)
1616
- [3. Parameter definitions](#3-parameter-definitions)
1717

@@ -21,15 +21,37 @@ ___
2121

2222
### 1. Set up the execution environment
2323

24-
The script should be executed from a Conda environment created using the [R_visualizations.yaml](/Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations/R_visualizations.yaml) environment file.
24+
The script should be executed from a [conda](https://docs.conda.io/en/latest/) environment created using the [R_visualizations.yaml](R_visualizations.yaml) environment file.
25+
> If you do not have conda installed, an introduction to conda with installation help and links to other resources can be found [here at Happy Belly Bioinformatics](https://astrobiomike.github.io/unix/conda-intro).
26+
27+
Download the [R_visualizations.yaml](R_visualizations.yaml) environment file and the [Illumina-R-visualizations.R](Illumina-R-visualizations.R) script by running the following commands:
28+
29+
```
30+
curl -LO https://github.com/nasa/GeneLab_Data_Processing/blob/dev2-amplicon-add-runsheet-visualizations/Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations/R_visualizations.yaml
31+
32+
curl -LO https://github.com/nasa/GeneLab_Data_Processing/blob/dev2-amplicon-add-runsheet-visualizations/Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations/Illumina-R-visualizations.R
33+
```
34+
35+
Next, create the AmpSeqVisualizations environment by running the following command:
36+
37+
```
38+
conda env create -f R_visualizations.yaml -n AmpSeqVisualizations
39+
```
40+
41+
Then activate the environment as follows:
42+
43+
```
44+
conda activate AmpSeqVisualizations
45+
```
46+
2547

2648
<br>
2749

2850
___
2951

3052
### 2. Run the visualization script manually
3153

32-
To run the script, the variables `runsheet_file`, `sample_info`, `counts`, `taxonomy`, `assay_suffix`, `plots_dir`, and `output_prefix` must be specified. The script can be manually executed via the command line by providing positional arguments.
54+
To run the script, the variables `runsheet_file`, `sample_info`, `counts`, `taxonomy`, `assay_suffix`, `plots_dir`, and `output_prefix` must be specified. The [Illumina-R-visualizations.R](Illumina-R-visualizations.R) script can be executed from the command line by providing these variables as positional arguments.
3355

3456
Additionally, the `RColorBrewer_Palette` variable can be modified in the script. This variable determines the color palette from the RColorBrewer package that is applied to the plots.
3557

@@ -46,7 +68,6 @@ output_prefix <- paste0(args[7])
4668
########################################
4769

4870
RColorBrewer_Palette <- "Set1"
49-
5071
```
5172

5273
Example run command:
@@ -68,4 +89,4 @@ ___
6889
* `assay_suffix` – specifies a string that is prepended to the start of the output file names. Default: ""
6990
* `plots_dir` – specifies the path where output files will be saved
7091
* `output_prefix` – specifies a string that is appended to the end of the output file names. Default: "_GLAmpSeq"
71-
* `RColorBrewer_Palette` – specifies the RColorBrewer palette that will be used for coloring in the plots. Options include "Set1", "Accent", "Dark2", "Paired", "Pastel1", "Pastel2", "Set2", and "Set3". Default: "Set1"
92+
* `RColorBrewer_Palette` – specifies the RColorBrewer palette that will be used for coloring in the plots. Options include "Set1", "Accent", "Dark2", "Paired", "Pastel1", "Pastel2", "Set2", and "Set3". Default: "Set1"

0 commit comments

Comments
 (0)