Skip to content

Commit 9c643de

Browse files
fixing typos
1 parent 6db96ff commit 9c643de

File tree

1 file changed

+10
-21
lines changed
  • Microarray/Agilent_1-channel/Workflow_Documentation/NF_MAAgilent1ch

1 file changed

+10
-21
lines changed

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

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ The current GeneLab Agilent 1 Channel Microarray consensus processing pipeline (
1414

1515
---
1616
The NF_MAAgilent1ch workflow is composed of three subworkflows as shown in the image above.
17-
Below is a description of each subworkflow and the additional output files generated that are not already indicated in the [GL-DPPD-7112 pipeline
18-
document](../../Pipeline_GL-DPPD-7112_Versions/GL-DPPD-7112.md):
17+
Below is a description of each subworkflow and the additional output files generated that are not already indicated in the [GL-DPPD-7112 pipeline document](../../Pipeline_GL-DPPD-7112_Versions/GL-DPPD-7112.md):
1918

2019
1. **Analysis Staging Subworkflow**
2120

@@ -91,16 +90,12 @@ We recommend installing Singularity on a system wide level as per the associated
9190
9291
### 2. Download the Workflow Files
9392
94-
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
95-
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:
93+
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:
9694
9795
```bash
98-
wget https://github.com/asaravia-butler/GeneLab_Data_Processing/releases/download/NF_MAAgilent1ch_1.0.2
99-
/NF_MAAgilent1ch_1.0.2
100-
.zip
96+
wget https://github.com/asaravia-butler/GeneLab_Data_Processing/releases/download/NF_MAAgilent1ch_1.0.2/NF_MAAgilent1ch_1.0.2.zip
10197
102-
unzip NF_MAAgilent1ch_1.0.2
103-
.zip
98+
unzip NF_MAAgilent1ch_1.0.2.zip
10499
```
105100
106101
<br>
@@ -109,17 +104,15 @@ unzip NF_MAAgilent1ch_1.0.2
109104
110105
### 3. Run the Workflow
111106
112-
While in the location containing the `NF_MAAgilent1ch_1.0.2
113-
` 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.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:
114108
> 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.
115109
116110
<br>
117111
118112
#### 3a. Approach 1: Run the workflow on a GeneLab Agilent 1 Channel Microarray dataset
119113
120114
```bash
121-
nextflow run NF_MAAgilent1ch_1.0.2
122-
/main.nf \
115+
nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
123116
-profile singularity \
124117
--osdAccession OSD-548 \
125118
--gldsAccession GLDS-548
@@ -132,8 +125,7 @@ nextflow run NF_MAAgilent1ch_1.0.2
132125
> Note: Specifications for creating a runsheet manually are described [here](examples/runsheet/README.md).
133126
134127
```bash
135-
nextflow run NF_MAAgilent1ch_1.0.2
136-
/main.nf \
128+
nextflow run NF_MAAgilent1ch_1.0.2/main.nf \
137129
-profile singularity \
138130
--runsheetPath </path/to/runsheet>
139131
```
@@ -142,8 +134,7 @@ nextflow run NF_MAAgilent1ch_1.0.2
142134
143135
**Required Parameters For All Approaches:**
144136
145-
* `NF_MAAgilent1ch_1.0.2
146-
/main.nf` - Instructs Nextflow to run the NF_MAAgilent1ch workflow
137+
* `NF_MAAgilent1ch_1.0.2/main.nf` - Instructs Nextflow to run the NF_MAAgilent1ch workflow
147138
148139
* `-profile` - Specifies the configuration profile(s) to load, `singularity` instructs Nextflow to setup and use singularity for all software called in the workflow
149140
@@ -175,8 +166,7 @@ nextflow run NF_MAAgilent1ch_1.0.2
175166
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:
176167
177168
```bash
178-
nextflow run NF_MAAgilent1ch_1.0.2
179-
/main.nf --help
169+
nextflow run NF_MAAgilent1ch_1.0.2/main.nf --help
180170
```
181171
182172
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.
@@ -190,8 +180,7 @@ See `nextflow run -h` and [Nextflow's CLI run command documentation](https://nex
190180
All R code steps and output are rendered within a Quarto document yielding the following:
191181
192182
- Output:
193-
- NF_MAAgilent1ch_1.0.2
194-
.html (html report containing executed code and output including QA plots)
183+
- NF_MAAgilent1ch_1.0.2.html (html report containing executed code and output including QA plots)
195184
196185
197186
The outputs from the Analysis Staging and V&V Pipeline Subworkflows are described below:

0 commit comments

Comments
 (0)