Skip to content

Commit d4b8190

Browse files
committed
SW_AmpIllumina-B: Vis Readme updates
* Add inputs, outputs; delete parameter definitions top level section
1 parent 9936a7a commit d4b8190

File tree

1 file changed

+28
-14
lines changed
  • Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/visualizations

1 file changed

+28
-14
lines changed

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

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The documentation for this script and its outputs can be found in steps 6-10 of
1313

1414
- [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)
16-
- [3. Parameter definitions](#3-parameter-definitions)
1716

1817
<br>
1918

@@ -68,18 +67,33 @@ Rscript /path/to/visualizations/Illumina-R-visualizations.R "/path/to/runsheet.c
6867

6968
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.
7069

71-
<br>
72-
73-
___
74-
75-
### 3. Parameter definitions
76-
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))
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))
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))
82-
* `assay_suffix` – specifies a string that is prepended to the start of the output file names. Default: ""
70+
**Parameter Definitions:**
71+
* `runsheet_file` – specifies the table containing sample metadata required for processing
72+
* `sample_info` – specifies the text file containing the IDs of each sample used, required for running the SW_AmpIllumina workflow
73+
* `counts` – specifies the ASV counts table
74+
* `taxonomy` – specifies the taxonomy table
75+
* `assay_suffix` – specifies a string that is appended to the end of the output file names. Default: "_GLAmpSeq"
8376
* `plots_dir` – specifies the path where output files will be saved
84-
* `output_prefix` – specifies a string that is appended to the end of the output file names. Default: "_GLAmpSeq"
77+
* `output_prefix` – specifies a string that is prepended to the start of the output file names. Default: ""
8578
* `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"
79+
80+
**Input Data:**
81+
* *runsheet.csv (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))
82+
* unique-sample-IDs.txt (output from [run_workflow.py](/Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/README.md#5-additional-output-files))
83+
* counts_GLAmpSeq.tsv (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))
84+
* taxonomy_GLAmpSeq.tsv (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))
85+
86+
**Output Data:**
87+
* **dendrogram_by_group{assay_suffix}.png** (dendrogram of euclidean distance - based hierarchical clustering of the samples, colored by experimental groups)
88+
* **rarefaction_curves{assay_suffix}.png** (Rarefaction curves plot for all samples)
89+
* **richness_and_diversity_estimates_by_sample{assay_suffix}.png** (Richness and diversity estimates plot for all samples)
90+
* **richness_and_diversity_estimates_by_group{assay_suffix}.png** (Richness and diversity estimates plot for all groups)
91+
* **relative_phyla{assay_suffix}.png** (taxonomic summaries plot based on phyla, for all samples)
92+
* **relative_classes{assay_suffix}.png** (taxonomic summaries plot based on class, for all samples)
93+
* **samplewise_phyla{assay_suffix}.png** (taxonomic summaries plot based on phyla, for all samples)
94+
* **samplewise_classes{assay_suffix}.png** (taxonomic summaries plot based on class, for all samples)
95+
* **PCoA_w_labels{assay_suffix}.png** (principle Coordinates Analysis plot of VST transformed ASV counts, with sample labels)
96+
* **PCoA_without_labels{assay_suffix}.png** (principle Coordinates Analysis plot of VST transformed ASV counts, without sample labels)
97+
* **normalized_counts{assay_suffix}.tsv** (size factor normalized ASV counts table)
98+
* **group1_vs_group2.csv** (differential abundance tables for all pairwise contrasts of groups)
99+
* **volcano_group1_vs_group2.png** (volcano plots for all pairwise contrasts of groups)

0 commit comments

Comments
 (0)