Skip to content

Commit 2e6d5bd

Browse files
Merge pull request #89 from cyouh95/DEV_NF_MAAgilent_1ch
NF_MAAgilent1ch: Update workflow version from 1.0.2 to 1.0.3 Fix cache location issues that arose in `quarto render` when using Nextflow v.23.10.1
2 parents 567fcd3 + 496eba9 commit 2e6d5bd

File tree

6 files changed

+22
-16
lines changed

6 files changed

+22
-16
lines changed

Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch/CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.0.2](https://github.com/asaravia-butler/GeneLab_Data_Processing/tree/NF_MAAgilent1ch_1.0.2/Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch) - 2023-04-28
8+
## [1.0.3](https://github.com/nasa/GeneLab_Data_Processing/tree/NF_MAAgilent1ch_1.0.3/Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch) - 2024-05-17
99

10-
### Added
10+
### Changed
11+
12+
- Fix cache location issues that arose in `quarto render` when using Nextflow v.23.10.1 ([#82](https://github.com/nasa/GeneLab_Data_Processing/issues/82))
13+
14+
## [1.0.2](https://github.com/nasa/GeneLab_Data_Processing/tree/NF_MAAgilent1ch_1.0.2/Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch) - 2023-04-28
1115

1216
### Added
1317

Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ We recommend installing Singularity on a system wide level as per the associated
9393
All files required for utilizing the NF_MAAgilent1ch GeneLab workflow for processing Agilent 1 Channel Microarray data are in the [workflow_code](workflow_code) directory. To get a copy of latest NF_MAAgilent1ch version on to your system, the code can be downloaded as a zip file from the release page then unzipped after downloading by running the following commands:
9494
9595
```bash
96-
wget https://github.com/nasa/GeneLab_Data_Processing/releases/download/NF_MAAgilent1ch_1.0.2/NF_MAAgilent1ch_1.0.2.zip
96+
wget https://github.com/nasa/GeneLab_Data_Processing/releases/download/NF_MAAgilent1ch_1.0.3/NF_MAAgilent1ch_1.0.3.zip
9797
98-
unzip NF_MAAgilent1ch_1.0.2.zip
98+
unzip NF_MAAgilent1ch_1.0.3.zip
9999
```
100100
101101
<br>
@@ -104,15 +104,15 @@ unzip NF_MAAgilent1ch_1.0.2.zip
104104
105105
### 3. Run the Workflow
106106
107-
While in the location containing the `NF_MAAgilent1ch_1.0.2` directory that was downloaded in [step 2](#2-download-the-workflow-files), you are now able to run the workflow. Below are three examples of how to run the NF_MAAgilent1ch workflow:
107+
While in the location containing the `NF_MAAgilent1ch_1.0.3` directory that was downloaded in [step 2](#2-download-the-workflow-files), you are now able to run the workflow. Below are three examples of how to run the NF_MAAgilent1ch workflow:
108108
> Note: Nextflow commands use both single hyphen arguments (e.g. -help) that denote general nextflow arguments and double hyphen arguments (e.g. --ensemblVersion) that denote workflow specific parameters. Take care to use the proper number of hyphens for each argument.
109109
110110
<br>
111111
112112
#### 3a. Approach 1: Run the workflow on a GeneLab Agilent 1 Channel Microarray dataset
113113
114114
```bash
115-
nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
115+
nextflow run NF_MAAgilent1ch_1.0.3/main.nf \
116116
-profile singularity \
117117
--osdAccession OSD-548 \
118118
--gldsAccession GLDS-548
@@ -125,7 +125,7 @@ nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
125125
> Note: Specifications for creating a runsheet manually are described [here](examples/runsheet/README.md).
126126
127127
```bash
128-
nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
128+
nextflow run NF_MAAgilent1ch_1.0.3/main.nf \
129129
-profile singularity \
130130
--runsheetPath </path/to/runsheet>
131131
```
@@ -134,7 +134,7 @@ nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
134134
135135
**Required Parameters For All Approaches:**
136136
137-
* `NF_MAAgilent1ch_1.0.2/main.nf` - Instructs Nextflow to run the NF_MAAgilent1ch workflow
137+
* `NF_MAAgilent1ch_1.0.3/main.nf` - Instructs Nextflow to run the NF_MAAgilent1ch workflow
138138
139139
* `-profile` - Specifies the configuration profile(s) to load, `singularity` instructs Nextflow to setup and use singularity for all software called in the workflow
140140
@@ -166,7 +166,7 @@ nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
166166
All parameters listed above and additional optional arguments for the NF_MAAgilent1ch workflow, including debug related options that may not be immediately useful for most users, can be viewed by running the following command:
167167
168168
```bash
169-
nextflow run NF_MAAgilent1ch_1.0.2/main.nf --help
169+
nextflow run NF_MAAgilent1ch_1.0.3/main.nf --help
170170
```
171171
172172
See `nextflow run -h` and [Nextflow's CLI run command documentation](https://nextflow.io/docs/latest/cli.html#run) for more options and details common to all nextflow workflows.
@@ -180,7 +180,7 @@ See `nextflow run -h` and [Nextflow's CLI run command documentation](https://nex
180180
All R code steps and output are rendered within a Quarto document yielding the following:
181181
182182
- Output:
183-
- NF_MAAgilent1ch_1.0.2.html (html report containing executed code and output including QA plots)
183+
- NF_MAAgilent1ch_1.0.3.html (html report containing executed code and output including QA plots)
184184
185185
186186
The outputs from the Analysis Staging and V&V Pipeline Subworkflows are described below:

Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch/workflow_code/bin/Agile1CMP.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Agilent 1 Channel Processing"
3-
subtitle: "Workflow Version: NF_MAAgilent1ch_1.0.2"
3+
subtitle: "Workflow Version: NF_MAAgilent1ch_1.0.3"
44
date: now
55
title-block-banner: true
66
format:

Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch/workflow_code/modules/AGILE1CH.nf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ process AGILE1CH {
3030
script:
3131
def limit_biomart_query_parameter = limit_biomart_query ? "-P DEBUG_limit_biomart_query:${limit_biomart_query}" : ''
3232
"""
33+
export HOME=\$PWD;
34+
3335
quarto render \$PWD/${qmd} \
3436
-P 'runsheet:${runsheet_csv}' \
3537
-P 'annotation_file_path:${annotation_file_path}' \

Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch/workflow_code/nextflow.config

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ manifest {
4444
description = 'Agilent 1 Channel Microarray Workflow for Document GL-DPPD-7112'
4545
mainScript = 'main.nf'
4646
defaultBranch = 'main'
47-
nextflowVersion = '>=22.10.1'
48-
version = '1.0.2'
47+
nextflowVersion = '>=23.10.1'
48+
version = '1.0.3'
4949
}
5050

5151
def trace_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss')

Microarray/Agilent_1-channel/Workflow_Documentation/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
55
## MAAgilent1ch Version and Corresponding Workflow
66

7-
|Pipeline Version|Current Workflow Version (for respective pipeline version)|
8-
|:---------------|:---------------------------------------------------------|
9-
|*[GL-DPPD-7112.md](../Pipeline_GL-DPPD-7112_Versions/GL-DPPD-7112.md)|[NF_MAAgilent1ch_1.0.2](NF_MAAgilent1ch)|
7+
|Pipeline Version|Current Workflow Version (for respective pipeline version)|Nextflow Version|
8+
|:---------------|:---------------------------------------------------------|:---------------|
9+
|*[GL-DPPD-7112.md](../Pipeline_GL-DPPD-7112_Versions/GL-DPPD-7112.md)|[NF_MAAgilent1ch_1.0.3](NF_MAAgilent1ch)|23.10.1|
1010

1111
*Current GeneLab Pipeline/Workflow Implementation
1212

0 commit comments

Comments
 (0)