Skip to content

Commit 9936a7a

Browse files
committed
SW_AmpIllumina-B: Vis script readme updates, fixes
- Convert local DPPD links to main repo URLs - Improve step 2 instructions in vis script readme
1 parent 35975a6 commit 9936a7a

File tree

2 files changed

+18
-25
lines changed
  • Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B

2 files changed

+18
-25
lines changed

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

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

33

44
## General workflow info <!-- omit in toc -->
5-
The current GeneLab Illumina amplicon sequencing data processing pipeline (AmpIllumina), [GL-DPPD-7104-B.md](../../Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md), is implemented as a [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow and utilizes [conda](https://docs.conda.io/en/latest/) environments to install/run all tools. This workflow (SW_AmpIllumina-B) is run using the command line interface (CLI) of any unix-based system. The workflow can be used even if you are unfamiliar with Snakemake and conda, but if you want to learn more about those, [this Snakemake tutorial](https://snakemake.readthedocs.io/en/stable/tutorial/tutorial.html) within [Snakemake's documentation](https://snakemake.readthedocs.io/en/stable/) is a good place to start for that, and 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).
5+
The current GeneLab Illumina amplicon sequencing data processing pipeline (AmpIllumina), [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), is implemented as a [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow and utilizes [conda](https://docs.conda.io/en/latest/) environments to install/run all tools. This workflow (SW_AmpIllumina-B) is run using the command line interface (CLI) of any unix-based system. The workflow can be used even if you are unfamiliar with Snakemake and conda, but if you want to learn more about those, [this Snakemake tutorial](https://snakemake.readthedocs.io/en/stable/tutorial/tutorial.html) within [Snakemake's documentation](https://snakemake.readthedocs.io/en/stable/) is a good place to start for that, and 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).
66

77
<br>
88

@@ -190,7 +190,7 @@ ___
190190
### 5. Additional output files
191191
192192
The outputs from the `run_workflow.py` and differential abundance analysis (DAA) / visualizations scripts are described below:
193-
> Note: Outputs from the Amplicon Seq - Illumina pipeline are documented in the [GL-DPPD-7104-B.md](../../Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md) processing protocol.
193+
> Note: Outputs from the Amplicon Seq - Illumina pipeline are documented in 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) processing protocol.
194194
195195
- **Metadata Outputs:**
196196
- \*_AmpSeq_v1_runsheet.csv (table containing metadata required for processing, including the raw reads files location)

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

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -51,41 +51,34 @@ ___
5151

5252
### 2. Run the visualization script manually
5353

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.
54+
The [Illumina-R-visualizations.R](./Illumina-R-visualizations.R) script can be executed from the command line by providing `runsheet_file`, `sample_info`, `counts`, `taxonomy`, `assay_suffix`, `plots_dir`, and `output_prefix` as positional arguments, in their respecive order.
5555

56-
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.
57-
58-
```R
59-
# Store command line args as variables #
60-
args <- commandArgs(trailingOnly = TRUE)
61-
runsheet_file <- paste0(args[1])
62-
sample_info <- paste0(args[2])
63-
counts <- paste0(args[3])
64-
taxonomy <- paste0(args[4])
65-
assay_suffix <- paste(args[5])
66-
plots_dir <- paste0(args[6])
67-
output_prefix <- paste0(args[7])
68-
########################################
69-
70-
RColorBrewer_Palette <- "Set1"
71-
```
56+
The example command below shows how to execute the script with the following parameters:
57+
* runsheet_file: /path/to/runsheet.csv
58+
* sample_info: /path/to/unique-sample-IDs.txt
59+
* counts: /path/to/counts_GLAmpSeq.tsv
60+
* taxonomy: /path/to/taxonomy_GLAmpSeq.tsv
61+
* assay_suffix: _GL_Ampseq
62+
* plots_dir: /path/to/Plots/
63+
* output_prefix: my_prefix_
7264

73-
Example run command:
7465
```bash
75-
Rscript /path/to/visualizations/Illumina-R-visualizations.R "{runsheet_file}" "{sample_info}" "{counts}" "{taxonomy}" "{assay_suffix}" "{plots_dir}" "{output_prefix}"
66+
Rscript /path/to/visualizations/Illumina-R-visualizations.R "/path/to/runsheet.csv" "/path/to/unique-sample-IDs.txt" "/path/to/counts_GLAmpSeq.tsv" "/path/to/taxonomy_GLAmpSeq.tsv" "_GL_Ampseq" "/path/to/Plots/" "my_prefix_"
7667
```
7768

69+
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.
70+
7871
<br>
7972

8073
___
8174

8275
### 3. Parameter definitions
8376

84-
**Parameter Definitions for Illumina-R-visualizations.R:**
85-
* `runsheet_file` – specifies the runsheet containing sample metadata required for processing (output from [GL-DPPD-7104-B step 6a](/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#6a-create-sample-runsheet))
77+
**Parameter definitions for Illumina-R-visualizations.R:**
78+
* `runsheet_file` – specifies the runsheet containing sample metadata required for processing (output from [GL-DPPD-7104-B step 6a](https://github.com/nasa/GeneLab_Data_Processing/blob/master/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#6a-create-sample-runsheet))
8679
* `sample_info` – specifies the text file containing the IDs of each sample used, required for running the SW_AmpIllumina workflow (output from [run_workflow.py](/Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/README.md#5-additional-output-files))
87-
* `counts` – specifies the ASV counts table (output from [GL-DPPD-7104-B step 5g](/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#5g-generating-and-writing-standard-outputs))
88-
* `taxonomy` – specifies the taxonomy table (output from [GL-DPPD-7104-B step 5g](/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#5g-generating-and-writing-standard-outputs))
80+
* `counts` – specifies the ASV counts table (output from [GL-DPPD-7104-B step 5g](https://github.com/nasa/GeneLab_Data_Processing/blob/master/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#5g-generating-and-writing-standard-outputs))
81+
* `taxonomy` – specifies the taxonomy table (output from [GL-DPPD-7104-B step 5g](https://github.com/nasa/GeneLab_Data_Processing/blob/master/Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-B.md#5g-generating-and-writing-standard-outputs))
8982
* `assay_suffix` – specifies a string that is prepended to the start of the output file names. Default: ""
9083
* `plots_dir` – specifies the path where output files will be saved
9184
* `output_prefix` – specifies a string that is appended to the end of the output file names. Default: "_GLAmpSeq"

0 commit comments

Comments
 (0)