Skip to content

Commit 3b66ab1

Browse files
committed
Update pipeline doc to GL-DPPD-7104-D
- Changed reference from GL-DPPD-7104-C to GL-DPPD-7104-D in the main README.md to reflect the latest pipeline version. - Updated the workflow documentation to link GL-DPPD-7104-D with the corresponding workflow version NF_AmpIllumina_1.0.9 and adjusted the previous version links accordingly.
1 parent ac3bcdb commit 3b66ab1

4 files changed

Lines changed: 3836 additions & 15 deletions

File tree

Amplicon/Illumina/Pipeline_GL-DPPD-7104_Versions/GL-DPPD-7104-C.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ Software Updates and Changes:
4545
| hexbin | N/A | 1.28.3 |
4646
| mia | N/A | 1.14.0 |
4747
| phyloseq | N/A | 1.50.0 |
48-
| rcolorbrewer | N/A | 1.1.3 |
48+
| RColorBrewer | N/A | 1.1.3 |
4949
| taxize | N/A | 0.10.0 |
5050
| tidyverse | N/A | 2.0.0 |
5151
| vegan | N/A | 2.6-10 |
5252
| vsn | N/A | 3.74.0 |
5353
| patchwork | N/A | 1.3.0 |
5454
| rstatix | N/A | 0.7.2 |
5555
| multcompView | N/A | 0.1-10 |
56-
| scales | N/A | 1.4.0 |
56+
| scales | N/A | 1.3.0 |
5757
| dendextend | N/A | 1.19.0 |
5858

5959
- Added new processing steps in R to generate processed data outputs for alpha and beta diversity, taxonomic summary plots, and differential abundance:
@@ -63,7 +63,7 @@ Software Updates and Changes:
6363
- Differential Abundance Testing ([Step 10](#9-differential-abundance-analysis)) with
6464
ANCOMBC 1 ([Step 10a](#10a-ancombc-1)), ANCOMBC 2 ([Step 10b](#10b-ancombc-2)), and Deseq2 ([Step 10c](#10c-deseq2))
6565
- Assay-specific suffixes were added where needed for OSDR ("_GLAmpSeq")
66-
- Updated [DECIPHER](https://www2.decipher.codes/data/Downloads/TrainingSets/) reference files to the following:
66+
- Updated [DECIPHER](https://decipher.codes/Downloads.html) reference files to the following:
6767
- ITS UNITE: "UNITE\_v2024\_April2024.RData"
6868
- SILVA SSU r138: "SILVA\_SSU\_r138\_2\_2024.RData"
6969
- PR2 v4.13: "PR2\_v4\_13\_March2021.RData"
@@ -128,6 +128,7 @@ Software Updates and Changes:
128128
|DADA2|1.34.0|[https://www.bioconductor.org/packages/release/bioc/html/dada2.html](https://www.bioconductor.org/packages/release/bioc/html/dada2.html)|
129129
|DECIPHER|3.2.0|[https://bioconductor.org/packages/release/bioc/html/DECIPHER.html](https://bioconductor.org/packages/release/bioc/html/DECIPHER.html)|
130130
|biomformat|1.34.0|[https://github.com/joey711/biomformat](https://github.com/joey711/biomformat)|
131+
|dp_tools|1.3.8|[https://github.com/torres-alexis/dp_tools](https://github.com/torres-alexis/dp_tools)|
131132
|ANCOMBC|2.8.0|[https://github.com/FrederickHuangLin/ANCOMBC](https://github.com/FrederickHuangLin/ANCOMBC)|
132133
|broom|1.0.7|[https://CRAN.R-project.org/package=broom](https://CRAN.R-project.org/package=broom)|
133134
|DescTools|0.99.59|[https://andrisignorell.github.io/DescTools/](https://andrisignorell.github.io/DescTools/)|
@@ -139,15 +140,15 @@ Software Updates and Changes:
139140
|hexbin|1.28.3|[https://CRAN.R-project.org/package=hexbin](https://CRAN.R-project.org/package=hexbin)|
140141
|mia|1.14.0|[https://github.com/microbiome/mia](https://github.com/microbiome/mia)|
141142
|phyloseq|1.50.0|[https://bioconductor.org/packages/release/bioc/html/phyloseq.html](https://bioconductor.org/packages/release/bioc/html/phyloseq.html)|
142-
|rcolorbrewer|1.1.3|[https://CRAN.R-project.org/package=RColorBrewer](https://CRAN.R-project.org/package=RColorBrewer)|
143+
|RColorBrewer|1.1.3|[https://CRAN.R-project.org/package=RColorBrewer](https://CRAN.R-project.org/package=RColorBrewer)|
143144
|taxize|0.10.0|[https://docs.ropensci.org/taxize/](https://docs.ropensci.org/taxize/)|
144145
|tidyverse|2.0.0|[https://CRAN.R-project.org/package=tidyverse](https://CRAN.R-project.org/package=tidyverse)|
145146
|vegan|2.6-10|[https://cran.r-project.org/package=vegan](https://cran.r-project.org/package=vegan)|
146147
|vsn|3.74.0|[https://bioconductor.org/packages/release/bioc/html/vsn.html](https://bioconductor.org/packages/release/bioc/html/vsn.html)|
147148
|patchwork|1.3.0|[https://CRAN.R-project.org/package=patchwork](https://CRAN.R-project.org/package=patchwork)|
148149
|rstatix|0.7.2|[https://CRAN.R-project.org/package=rstatix](https://CRAN.R-project.org/package=rstatix)|
149150
|multcompView|0.1-10|[https://CRAN.R-project.org/package=multcompView](https://CRAN.R-project.org/package=multcompView)|
150-
|scales|1.4.0|[https://CRAN.R-project.org/package=scales](https://CRAN.R-project.org/package=scales)|
151+
|scales|1.3.0|[https://CRAN.R-project.org/package=scales](https://CRAN.R-project.org/package=scales)|
151152
|dendextend|1.19.0|[https://CRAN.R-project.org/package=dendextend](https://CRAN.R-project.org/package=dendextend)|
152153

153154
# Reference databases used
@@ -205,13 +206,18 @@ multiqc --interactive -n raw_multiqc_GLAmpSeq -o /path/to/raw_multiqc/output/raw
205206
zip -r raw_multiqc_GLAmpSeq_report.zip raw_multiqc_GLAmpSeq_report
206207
```
207208

208-
**Parameter Definitions:**
209-
209+
**Parameter Definitions:**
210+
**multiqc**
210211
- `--interactive` – force reports to use interactive plots
211212
- `-n` – prefix name for output files
212213
- `-o` – the output directory to store results
213214
- `/path/to/directory/containing/raw_fastqc/files` – the directory holding the output data from the FastQC run, provided as a positional argument
214215

216+
**zip**
217+
- `-r` - recurse into directories
218+
- `raw_multiqc_GLAmpSeq_report.zip` – positional argument naming the zip output file
219+
- `raw_multiqc_GLAmpSeq_report` – positional argument naming the input folder to package
220+
215221
**Input Data:**
216222

217223
* \*fastqc.zip (FastQC output data, output from [Step 1a](#1a-raw-data-qc))
@@ -347,13 +353,18 @@ multiqc --interactive -n filtered_multiqc_GLAmpSeq -o /path/to/filtered_multiqc/
347353
zip -r filtered_multiqc_GLAmpSeq_report.zip filtered_multiqc_GLAmpSeq_report
348354
```
349355

350-
**Parameter Definitions:**
351-
356+
**Parameter Definitions:**
357+
**multiqc**
352358
- `--interactive` – force reports to use interactive plots
353359
- `-n` – prefix name for output files
354360
- `-o` – the output directory to store results
355361
- `/path/to/directory/containing/filtered_fastqc/files` – the directory holding the output data from the FastQC run, provided as a positional argument
356362

363+
**zip**
364+
- `-r` - recurse into directories
365+
- `filtered_multiqc_GLAmpSeq_report.zip` – positional argument naming the zip output file
366+
- `filtered_multiqc_GLAmpSeq_report` – positional argument naming the input folder to package
367+
357368
**Input Data:**
358369

359370
* \*fastqc.zip (FastQC output data, output from [Step 4a](#4a-filtered-data-qc))
@@ -371,7 +382,7 @@ zip -r filtered_multiqc_GLAmpSeq_report.zip filtered_multiqc_GLAmpSeq_report
371382
## 5. Calculate Error Mdel, Apply DADA2 Algorithm, Assign Taxonomy, and Create Output Tables
372383
> The following is run in an R environment.
373384
374-
These example commands as written assume paired-end data, with notes included on what would be different if working with single-end data. The taxonomy reference database used below is an example only, suitable for the example 16S dataset ([GLDS-200](https://osdr.nasa.gov/bio/repo/data/studies/OSD-200)) used here. Other taxonomy references databases designed for DECIPHER can be found here: [https://www2.decipher.codes/data/Downloads/TrainingSets/](https://www2.decipher.codes/data/Downloads/TrainingSets/)
385+
These example commands as written assume paired-end data, with notes included on what would be different if working with single-end data. The taxonomy reference database used below is an example only, suitable for the example 16S dataset ([GLDS-200](https://osdr.nasa.gov/bio/repo/data/studies/OSD-200)) used here. Other taxonomy references databases designed for DECIPHER can be found here: [https://decipher.codes/Downloads.html](https://decipher.codes/Downloads.html)
375386

376387
<br>
377388

@@ -507,7 +518,7 @@ seqtab.nochim <- removeBimeraDenovo(unqs=seqtab, method="consensus", multithread
507518
dna <- DNAStringSet(getSequences(seqtab.nochim))
508519

509520
## Downloading the reference R taxonomy object: ##
510-
download.file(url = "https://figshare.com/ndownloader/files/52846199",
521+
download.file(url = "https://api.figshare.com/v2/file/download/52846199",
511522
destfile = "SILVA_SSU_r138_2_2024.RData",
512523
method = "libcurl",
513524
headers = c("User-Agent" = "Mozilla/5.0"))
@@ -517,6 +528,7 @@ load("SILVA_SSU_r138_2_2024.RData")
517528

518529
## Classifying sequences:
519530
tax_info <- IdTaxa(test=dna, trainingSet=trainingSet, strand="both", processors=NULL)
531+
```
520532

521533
**Parameter Definitions:**
522534

@@ -584,6 +596,16 @@ write_biom(biom_object, "taxonomy-and-counts_GLAmpSeq.biom")
584596
tax_and_count_tab <- merge(tax_tab, asv_tab)
585597
write.table(tax_and_count_tab, "taxonomy-and-counts_GLAmpSeq.tsv", sep="\t", quote=FALSE, row.names=FALSE)
586598
```
599+
```bash
600+
zip -j -q taxonomy-and-counts_GLAmpSeq.biom.zip taxonomy-and-counts_GLAmpSeq.biom
601+
```
602+
603+
**Parameter Definitions:**
604+
**zip**
605+
- `-j` - junk (don't record) directory names
606+
- `-q` – quiet operation
607+
- `taxonomy-and-counts_GLAmpSeq.biom.zip` – positional argument naming the zip output file
608+
- `taxonomy-and-counts_GLAmpSeq.biom` – positional argument naming the input folder to package
587609

588610
**Input Data:**
589611

@@ -596,7 +618,8 @@ write.table(tax_and_count_tab, "taxonomy-and-counts_GLAmpSeq.tsv", sep="\t", quo
596618
* **counts_GLAmpSeq.tsv** (a tab-separated file containing the sample feature count table)
597619
* **taxonomy_GLAmpSeq.tsv** (a tab-separated file containing the taxonomy table)
598620
* **taxonomy-and-counts_GLAmpSeq.tsv** (a tab-separated file containing the combined taxonomy and count table)
599-
* **taxonomy-and-counts_GLAmpSeq.biom** (a biom-formatted file containing the count and taxonomy table)
621+
* **taxonomy-and-counts_GLAmpSeq.biom.zip** (a zip package containing the biom-formatted file)
622+
* taxonomy-and-counts_GLAmpSeq.biom (a biom-formatted file containing the count and taxonomy table)
600623
* **read-count-tracking_GLAmpSeq.tsv** (a tab-separated file containing the read counts at each processing step)
601624

602625
<br>

0 commit comments

Comments
 (0)