|
51 | 51 |
|
52 | 52 | ### 2. Run the visualization script manually
|
53 | 53 |
|
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. |
55 | 55 |
|
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_ |
72 | 64 |
|
73 |
| -Example run command: |
74 | 65 | ```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_" |
76 | 67 | ```
|
77 | 68 |
|
| 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 | + |
78 | 71 | <br>
|
79 | 72 |
|
80 | 73 | ___
|
81 | 74 |
|
82 | 75 | ### 3. Parameter definitions
|
83 | 76 |
|
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)) |
86 | 79 | * `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)) |
89 | 82 | * `assay_suffix` – specifies a string that is prepended to the start of the output file names. Default: ""
|
90 | 83 | * `plots_dir` – specifies the path where output files will be saved
|
91 | 84 | * `output_prefix` – specifies a string that is appended to the end of the output file names. Default: "_GLAmpSeq"
|
|
0 commit comments