Skip to content

Commit

Permalink
Added readme and profile pulling for unc_longleaf cutandrun config
Browse files Browse the repository at this point in the history
  • Loading branch information
Austin Hepperla committed Apr 10, 2024
1 parent 0985a0b commit 500a43c
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ Currently documentation is available for the following pipelines within specific
- ampliseq
- [BINAC](docs/pipeline/ampliseq/binac.md)
- [UPPMAX](docs/pipeline/ampliseq/uppmax.md)
- cutandrun
- [UNC_LONGLEAF](docs/pipeline/cutandrun/unc_longleaf.md)
- demultiplex
- [AWS_TOWER](docs/pipeline/demultiplex/aws_tower.md)
- eager
Expand Down
22 changes: 22 additions & 0 deletions docs/pipeline/cutandrun/unc_longleaf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# nf-core/configs: UNC's Longleaf CUT&RUN specific configuration

Extra specific configuration for eager pipeline

## Pipeline specific profiles

Specific-pipeline profiles exist for the following pipelines, and will be automatically loaded when supplying `-profile unc_longleaf` to your command:

- cutandrun

## Usage

To use, run the pipeline with `-profile unc_longleaf`.

This will download and launch the eager specific [`unc_longleaf.config`](../../../conf/pipeline/cutandrun/unc_longleaf.config) which is adapted to data generated at UNC-CH and
processed on the Longleaf HPC.

Example: `nextflow run nf-core/cutandrun -profile unc_longleaf`

### Specifics

This custom config adds extra memory to the FRAG_LEN_HIST and DEEPTOOLS_PLOTHEATMAP_GENE_ALL as the jobs kept failing with default memory limits
13 changes: 13 additions & 0 deletions pipeline/cutandrun.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/*
* ------------------------------------------------------
* nfcore/cutandrun custom profile Nextflow config file
* ------------------------------------------------------
* Config options for custom environments.
* Cluster-specific config options should be saved
* in the conf/pipeline/cutandrun folder and imported
* under a profile name here.
*/

profiles {
unc_longleaf { includeConfig "${params.custom_config_base}/conf/pipeline/cutandrun/unc_longleaf.config" }
}

0 comments on commit 500a43c

Please sign in to comment.