Skip to content

Commit fe7b37b

Browse files
committed
feat: update details for 1.0.1-RC1 release candidate
1 parent 1623006 commit fe7b37b

File tree

7 files changed

+40
-33
lines changed

7 files changed

+40
-33
lines changed

Microarray/Affymetrix/Pipeline_GL-DPPD-7114_Versions/GL-DPPD-7114.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> **This page holds an overview and instructions for how GeneLab processes Affymetrix microarray datasets. Exact processing commands and GL-DPPD-7114 version used for specific GeneLab datasets (GLDS) are provided with their processed data in the [Open Science Data
44
Repository (OSDR)](https://osdr.nasa.gov/bio/repo).**
55
>
6-
> \* The pipeline detailed below is currently used for animal studies only, it will be updated soon for processing plants and microbe microarray data.
6+
> \* The pipeline detailed below is currently used for animal and Arabidopsis Thaliana studies only, it will be updated soon for processing microbe microarray data and other plant data.
77
88
---
99

Microarray/Affymetrix/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414

1515
* [**Pipeline_GL-DPPD-7114_Versions**](Pipeline_GL-DPPD-7114_Versions)
1616

17-
- Contains the current and previous GeneLab Affymetrix microarray data processing pipeline (NF_MAAffy) versions documentation
17+
- Contains the current and previous GeneLab Affymetrix microarray data processing pipeline (NF_MAAffymetrix) versions documentation
1818

1919
* [**Workflow_Documentation**](Workflow_Documentation)
2020

21-
- Contains instructions for installing and running the GeneLab NF_MAAffy workflow
21+
- Contains instructions for installing and running the GeneLab NF_MAAffymetrix workflow
2222

2323
---
2424
**Developed and maintained by:**

Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix/CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@ 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.1](https://github.com/asaravia-butler/GeneLab_Data_Processing/tree/NF_MAAffymetrix_1.0.1/Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix) - 2023-04-28
9+
10+
### Added
11+
12+
- Support for Arabidposis Thaliana datasets using the plants ensembl FTP server.
13+
- Support for raw data FeatureSets (building on existing support for ExpressionSets)
14+
- Better support for non-ascii characters in the runsheet, usually caused by such characters in the original ISA archive the runsheet is generated from.
15+
16+
### Fixed
17+
18+
- Typos related to shared code with Agilent 1 Channel platform.
19+
20+
### Changed
21+
22+
- Error message when encountering unique columns when reordering tables is now clearer about what unique columns were found.
23+
- Post Processing Workflow: Assay Table Update now added '_array_' prefix to processed files instead of '_microarray_' prefix.
24+
825
## [1.0.0](https://github.com/asaravia-butler/GeneLab_Data_Processing/tree/NF_MAAffymetrix_1.0.0/Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix) - 2023-04-24
926

1027
### Added

Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ All files required for utilizing the NF_MAAffymetrix GeneLab workflow for proces
9696
copy of latest NF_MAAffymetrix 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:
9797
9898
```bash
99-
wget https://github.com/asaravia-butler/GeneLab_Data_Processing/releases/download/NF_MAAffymetrix_1.0.0/NF_MAAffymetrix_1.0.0.zip
99+
wget https://github.com/asaravia-butler/GeneLab_Data_Processing/releases/download/NF_MAAffymetrix_1.0.1/NF_MAAffymetrix_1.0.1.zip
100100
101-
unzip NF_MAAffymetrix_1.0.0.zip
101+
unzip NF_MAAffymetrix_1.0.1.zip
102102
```
103103
104104
<br>
@@ -107,15 +107,15 @@ unzip NF_MAAffymetrix_1.0.0.zip
107107
108108
### 3. Run the Workflow
109109
110-
While in the location containing the `NF_MAAffymetrix_1.0.0` 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_MAAffymetrix workflow:
110+
While in the location containing the `NF_MAAffymetrix_1.0.1` 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_MAAffymetrix workflow:
111111
> 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.
112112
113113
<br>
114114
115115
#### 3a. Approach 1: Run the workflow on a GeneLab Affymetrix Microarray dataset
116116
117117
```bash
118-
nextflow run NF_MAAffymetrix_1.0.0/main.nf \
118+
nextflow run NF_MAAffymetrix_1.0.1/main.nf \
119119
-profile singularity \
120120
--osdAccession OSD-266 \
121121
--gldsAccession GLDS-266
@@ -128,7 +128,7 @@ nextflow run NF_MAAffymetrix_1.0.0/main.nf \
128128
> Note: Specifications for creating a runsheet manually are described [here](examples/runsheet/README.md).
129129
130130
```bash
131-
nextflow run NF_MAAffymetrix_1.0.0/main.nf \
131+
nextflow run NF_MAAffymetrix_1.0.1/main.nf \
132132
-profile singularity \
133133
--runsheetPath </path/to/runsheet>
134134
```
@@ -137,7 +137,7 @@ nextflow run NF_MAAffymetrix_1.0.0/main.nf \
137137
138138
**Required Parameters For All Approaches:**
139139
140-
* `NF_MAAffymetrix_1.0.0/main.nf` - Instructs Nextflow to run the NF_MAAffymetrix workflow
140+
* `NF_MAAffymetrix_1.0.1/main.nf` - Instructs Nextflow to run the NF_MAAffymetrix workflow
141141
142142
* `-profile` - Specifies the configuration profile(s) to load, `singularity` instructs Nextflow to setup and use singularity for all software called in the workflow
143143
@@ -169,7 +169,7 @@ nextflow run NF_MAAffymetrix_1.0.0/main.nf \
169169
All parameters listed above and additional optional arguments for the NF_MAAffymetrix workflow, including debug related options that may not be immediately useful for most users, can be viewed by running the following command:
170170
171171
```bash
172-
nextflow run NF_MAAffymetrix_1.0.0/main.nf --help
172+
nextflow run NF_MAAffymetrix_1.0.1/main.nf --help
173173
```
174174
175175
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.
@@ -183,7 +183,7 @@ See `nextflow run -h` and [Nextflow's CLI run command documentation](https://nex
183183
All R code steps and output are rendered within a Quarto document yielding the following:
184184
185185
- Output:
186-
- NF_MAAffymetrix_1.0.0.html (html report containing executed code and output including QA plots)
186+
- NF_MAAffymetrix_1.0.1.html (html report containing executed code and output including QA plots)
187187
188188
189189
The outputs from the Analysis Staging and V&V Pipeline Subworkflows are described below:

Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix/workflow_code/bin/Affymetrix.qmd

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

Microarray/Affymetrix/Workflow_Documentation/NF_MAAffymetrix/workflow_code/nextflow.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ manifest {
4545
mainScript = 'main.nf'
4646
defaultBranch = 'main'
4747
nextflowVersion = '>=22.10.0'
48-
version = '1.0.0'
48+
version = '1.0.1'
4949
}
5050

5151
// Section related to resource usage
Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
1-
# GeneLab bioinformatics processing pipeline for Affymetrix microarray data
1+
# GeneLab RNAseq Workflow Information
22

3+
> ** For the processing pipeline for Affymetrix microarray data,
4+
[`GL-DPPD-7114.md`](../Pipeline_GL-DPPD-7114_Versions/GL-DPPD-7114.md),
5+
GeneLab has wrapped each step of the pipeline into a workflow with validation and verification of output files built in after each step. The table below lists (and links to) each NF_MAAffymetrix version and the corresponding workflow subdirectory, the current NF_MAAffymetrix/workflow implementation is indicated. Each workflow subdirectory contains information about the workflow along with instructions for installation and usage.**
36

4-
> **The document [`GL-DPPD-7114.md`](Pipeline_GL-DPPD-7114_Versions/GL-DPPD-7114.md) holds an overview and example commands for how GeneLab processes Affymetrix microarray datasets. See the [Repository Links](#repository-links) descriptions below for more information. Processed data output files and processing code is provided for each GLDS dataset along with the processed data in the [GeneLab Data Systems (GLDS) repository](https://genelab-data.ndc.nasa.gov/genelab/projects).**
7+
## NF_MAAffymetrix Version and Corresponding Workflow
58

6-
---
9+
|Pipeline Version|Current Workflow Version (for respective pipeline version)|Nextflow Version|
10+
|:---------------|:---------------------------------------------------------|:---------------|
11+
|*[GL-DPPD-7114.md](../Pipeline_GL-DPPD-7114_Versions/GL-DPPD-7114.md)|[1.0.1](NF_MAAffymetrix)|22.10.1|
712

8-
<p align="center">
9-
<a href="../images/GL-affymetrix-overview.pdf"><img src="../images/GL-affymetrix-overview.png"></a>
10-
</p>
13+
*Current GeneLab Pipeline/Workflow Implementation
1114

12-
---
13-
## Repository Links
14-
15-
* [**Pipeline_GL-DPPD-7114_Versions**](Pipeline_GL-DPPD-7114_Versions)
16-
17-
- Contains the current and previous GeneLab Affymetrix microarray data processing pipeline (NF_MAAffymetrix) versions documentation
18-
19-
* [**Workflow_Documentation**](Workflow_Documentation)
20-
21-
- Contains instructions for installing and running the GeneLab NF_MAAffymetrix workflow
22-
23-
---
24-
**Developed and maintained by:**
25-
Jonathan Oribello
15+
> See the [workflow changelog](NF_MAAffymetrix/CHANGELOG.md) to access previous workflow versions and view all changes associated with each version update.

0 commit comments

Comments
 (0)