Skip to content

Commit e21868f

Browse files
authored
Updated Metagenomics READMEs and added NF_Metagenomics repository links (#198)
1 parent a3ad2d6 commit e21868f

11 files changed

Lines changed: 31 additions & 25 deletions

File tree

.gitmodules

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
[submodule "Amplicon/Illumina/Workflow_Documentation/NF_AmpIllumina"]
22
path = Amplicon/Illumina/Workflow_Documentation/NF_AmpIllumina
33
url = https://github.com/nasa/GeneLab_AmpliconSeq_Workflow
4-
[submodule "NF_MGIllumina"]
5-
path = Metagenomics/Low_Biomass/Workflow_Documentation/NF_MGIllumina
6-
url = https://github.com/nasa/GeneLab_Metagenomics_Workflow
4+
[submodule "Metagenomics/Low_Biomass/Workflow_Documentation/NF_Metagenomics"]
5+
path = Metagenomics/Low_Biomass/Workflow_Documentation/NF_Metagenomics
6+
url = https://github.com/nasa/GeneLab_Metagenomics_Workflow/
7+
branch = DEV
8+
[submodule "Metagenomics/Illumina/Workflow_Documentation/NF_Metagenomics"]
9+
path = Metagenomics/Illumina/Workflow_Documentation/NF_Metagenomics
10+
url = https://github.com/nasa/GeneLab_Metagenomics_Workflow/
711
branch = DEV

Metagenomics/Illumina/Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-B.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,10 @@ Software Updates and Changes:
4444
| dplyr | N/A | 1.2.0 |
4545
| ggplot2 | N/A | 4.0.2 |
4646
| glue | N/A | 1.8.0 |
47+
| magrittr | N/A | 2.0.5 |
4748
| purrr | N/A | 1.2.1 |
4849
| readr | N/A | 2.2.0 |
50+
| scales | N/A | 1.4.0 |
4951
| stringr | N/A | 1.6.0 |
5052
| tibble | N/A | 3.3.1 |
5153
| tidyr | N/A | 1.3.2 |
@@ -213,8 +215,8 @@ Software Updates and Changes:
213215
| readr | 2.2.0 | [https://readr.tidyverse.org](https://readr.tidyverse.org) |
214216
| scales | 1.4.0 | [https://scales.r-lib.org](https://scales.r-lib.org) |
215217
| stringr | 1.6.0 | [https://stringr.tidyverse.org](https://stringr.tidyverse.org) |
216-
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.orgtext) |
217-
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.orgtext) |
218+
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.org) |
219+
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.org) |
218220
> **Note:** pavian R package requires R version 4.0.5
219221
220222
---

Metagenomics/Illumina/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
# GeneLab bioinformatics processing pipeline for Illumina metagenomics sequencing data
33

4-
> **The document [`GL-DPPD-7107-A.md`](Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-A.md) holds an overview and example commands for how GeneLab processes Illumina metagenomics sequencing datasets. See the [Repository Links](#repository-links) descriptions below for more information. Processed data output files and processing code are provided for each GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
4+
> **The document [`GL-DPPD-7107-B.md`](Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-B.md) holds an overview and example commands for how GeneLab processes Illumina metagenomics sequencing datasets. See the [Repository Links](#repository-links) descriptions below for more information. Processed data output files and a GeneLab data processing summary are provided for each GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
55
>
6-
> Note: The exact processing commands and MGIllumina version used for specific GLDS datasets can be found in the *_processing_info.zip file under "Files" for each respective GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).
6+
> Note: The exact processing commands and MGIllumina or Metagenomics workflow version used for specific GLDS datasets can be found in the *_processing_info.zip file under "Files" for each respective GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).
77
88
---
99

@@ -21,7 +21,7 @@
2121

2222
* [**Workflow_Documentation**](Workflow_Documentation)
2323

24-
- Contains instructions for installing and running the GeneLab MGIllumina workflow
24+
- Contains instructions for installing and running the GeneLab MGIllumina or Metagenomics workflows
2525

2626
---
2727

Submodule NF_Metagenomics added at 285ec01
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
# GeneLab Illumina Metagenomics Seq Workflow Information
22

3-
> **GeneLab has wrapped each step of the Illumina metagenomics sequencing data processing pipeline (MGIllumina) into a workflow. The table below lists (and links to) each MGIllumina version and the corresponding workflow subdirectory, the current MGIllumina pipeline/workflow implementation is indicated. The workflow subdirectory contains information about the workflow along with instructions for installation and usage. Exact workflow run info and MGIllumina version used to process specific datasets that have been released are provided with their processed data in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
3+
> **GeneLab has wrapped each step of the Illumina metagenomics sequencing data processing pipeline into a workflow. The table below lists (and links to) each Metagenomics Workflow version and the corresponding workflow subdirectory, the current pipeline/workflow implementation is indicated. The workflow subdirectory contains information about the workflow along with instructions for installation and usage. Exact workflow run info and workflow version used to process specific datasets that have been released are provided with their processed data in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
44
55
## MGIllumina Pipeline Version and Corresponding Workflow
66

77
|Pipeline Version|Current Workflow Version (for respective pipeline version)|Nextflow Version|
88
|:---------------|:---------------------------------------------------------|:---------------|
9-
|*[GL-DPPD-7107-A.md](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-A.md)|[NF_MGIllumina_1.0.0](NF_MGIllumina)|24.04.4|
9+
|*[GL-DPPD-7107-B.md](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-B.md)|[NF_Metagenomics_1.0.0](https://github.com/nasa/GeneLab_Metagenomics_Workflow/tree/DEV)|24.04.4|
10+
|[GL-DPPD-7107-A.md](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-A.md)|[NF_MGIllumina_1.0.0](NF_MGIllumina)|24.04.4|
1011
|[GL-DPPD-7107.md](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107.md)|[SW_MGIllumina_2.0.4](SW_MGIllumina)|N/A (Snakemake v7.26.0)|
1112

1213

1314
*Current GeneLab Pipeline/Workflow Implementation
1415

15-
> See the [workflow change log](NF_MGIllumina/CHANGELOG.md) to access previous workflow versions and view all changes associated with each version update.
16+
> See the workflow change log for [NF_Metagenomics](https://github.com/nasa/GeneLab_Metagenomics_Workflow/blob/DEV/CHANGELOG.md) to view all changes associated with each workflow version update.
17+
18+
> All workflow changes associated with the previous version of the GeneLab Metagenomics Pipeline ([GL-DPPD-7107-A](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107-A.md) or [GL-DPPD-7107](../Pipeline_GL-DPPD-7107_Versions/GL-DPPD-7107.md)) can be found in the [NF_MGIllumina Change Log](./NF_MGIllumina/CHANGELOG.md) or the [SW_MGIllumina Change Log](./SW_MGIllumina/CHANGELOG.md), respectively.

Metagenomics/Low_Biomass/Pipeline_GL-DPPD-7116_Versions/GL-DPPD-7116.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ Barbara Novak (GeneLab Data Processing Lead)
190190
| readr | 2.2.0 | [https://readr.tidyverse.org](https://readr.tidyverse.org) |
191191
| scales | 1.4.0 | [https://scales.r-lib.org](https://scales.r-lib.org) |
192192
| stringr | 1.6.0 | [https://stringr.tidyverse.org](https://stringr.tidyverse.org) |
193-
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.orgtext) |
194-
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.orgtext) |
193+
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.org) |
194+
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.org) |
195195
> **Note:** pavian R package requires R version 4.0.5
196196
---
197197

Metagenomics/Low_Biomass/Pipeline_GL-DPPD-7117_Versions/GL-DPPD-7117.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ Barbara Novak (GeneLab Data Processing Lead)
180180
| readr | 2.2.0 | [https://readr.tidyverse.org](https://readr.tidyverse.org) |
181181
| scales | 1.4.0 | [https://scales.r-lib.org](https://scales.r-lib.org) |
182182
| stringr | 1.6.0 | [https://stringr.tidyverse.org](https://stringr.tidyverse.org) |
183-
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.orgtext) |
184-
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.orgtext) |
183+
| tibble | 3.3.1 | [https://tibble.tidyverse.org](https://tibble.tidyverse.org) |
184+
| tidyr | 1.3.2 | [https://tidyr.tidyverse.org](https://tidyr.tidyverse.org) |
185185
> **Note:** pavian R package requires R version 4.0.5
186186
187187
---

Metagenomics/Low_Biomass/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# GeneLab bioinformatics processing pipelines for low-biomass metagenomics sequencing data
22

3-
> **Documents [`GL-DPPD-7116`](Pipeline_GL-DPPD-7116_Versions/GL-DPPD-7116.md) and [`GL-DPPD-7117.md`](Pipeline_GL-DPPD-7117_Versions/GL-DPPD-7117.md) contain overview and example commands for how GeneLab processes low-biomass metagenomics datasets for long- and short-read data, respectively. See the [Repository Links](#repository-links) descriptions below for more information. Processed data output files and a GeneLab data processing summary is provided for each GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
3+
> **Documents [`GL-DPPD-7116`](Pipeline_GL-DPPD-7116_Versions/GL-DPPD-7116.md) and [`GL-DPPD-7117.md`](Pipeline_GL-DPPD-7117_Versions/GL-DPPD-7117.md) contain overview and example commands for how GeneLab processes low-biomass metagenomics datasets for long- and short-read data, respectively. See the [Repository Links](#repository-links) descriptions below for more information. Processed data output files and a GeneLab data processing summary are provided for each GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).**
44
5-
<br>
5+
> Note: The exact processing commands and Metagenomics workflow version used for specific GLDS datasets can be found in the *_processing_info.zip file under "Files" for each respective GLDS dataset in the [Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/).
66
77
---
88
## Repository Links
Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)