Skip to content

Commit 26f3bb2

Browse files
authored
Update pipelines.md
1 parent 763a1b2 commit 26f3bb2

1 file changed

Lines changed: 25 additions & 13 deletions

File tree

docs/pipelines.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -164,28 +164,29 @@ We use FAS to run pipelines in scratch, main storage location for data is still
164164
- Run pipelines in scratch: `/n/netscratch/hsph_bioinfo/Lab`
165165
- Keep downstream analysis in PIs folder: `/n/holylfs05/LABS/hsph_bioinfo/Lab/PIs`
166166

167+
Pipelines that have been run so far in FAS:
168+
- rnaseq
169+
- scrnaseq
170+
- cutandrun
171+
172+
Before using nextflow, you need to load a recent version of java:
173+
167174
```
168175
module load jdk/21.0.2-fasrc01
169176
```
170177

171178
Use nextflow at `/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nextflow`
172179

173-
Use config file at `/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config`
180+
Use config file at `/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/cannon.config`
174181

175182
Example command to run in an interactive job:
176-
183+
Note that this is only for test datasets requiring minimal CPUs, memory, and parallelization. Otherwise, submit as sbatch.
177184
```
178185
/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nextflow run nf-core/rnaseq -profile test,singularity --outdir tmp -c /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config
179186
```
180187

181-
For non-test data, this is the head job you need to submit. Copy first the config files and modified as needed:
182-
183-
```
184-
cp /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config .
185-
cp /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/rnaseq.config .
186-
```
187-
188-
And then modify this template as needed before using it:
188+
For non-test data, you will use sbatch to submit the head job of the pipeline, which will in turn submit the child jobs.
189+
Modify this template as needed before using it:
189190

190191
```
191192
#!/bin/bash
@@ -202,15 +203,26 @@ And then modify this template as needed before using it:
202203
203204
module load jdk/21.0.2-fasrc01
204205
206+
# modify these paths as necessary to point to the containers for the pipeline you're using
205207
export NXF_APPTAINER_CACHEDIR=/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nfcore-rnaseq
206208
export NXF_SINGULARITY_LIBRARYDIR=/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nfcore-rnaseq
207209
210+
# Optional: if you'd like to monitor your run in Seqera Platform, set up a token there and use it here
211+
export TOWER_WORKSPACE_ID=268530979103043
212+
export TOWER_ACCESS_TOKEN=<your_access_token>
213+
208214
OUTPUT=path_to_results
209215
210-
/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nextflow run nf-core/rnaseq -r 3.14.0 \
216+
/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/nextflow run nf-core/rnaseq
217+
-r 3.14.0 \
211218
-profile singularity \
219+
# next line is for passing pipeline parameters. can also insead use --params-file and use JSON downloaded from seqera
212220
-c analysis.config \
213-
-c rnaseq.config \
214-
--outdir $OUTPUT -c fas.config \
221+
# next line is for optimizing resource requests, file does not yet exist for all pipelines
222+
-c rnaseq.resources.config \
223+
--outdir $OUTPUT
224+
-c cannon.config \
225+
# next line optional, if you want to monitor your run in Seqera Platform
226+
-with-tower
215227
-resume
216228
```

0 commit comments

Comments
 (0)