millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-22 00:26:03 +00:00
Code Issues Releases Packages Activity

Added instructions for module loading

Browse source
This commit is contained in:
Rogan Grant 2021-07-28 18:11:10 -05:00
parent 24a2949fe2
commit 482478878d
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/nu_genomics.md
View file

@ -1,6 +1,6 @@
# nf-core/configs: NU_Genomics Configuration
All nf-core pipelines have been successfully configured for use on the Quest Genomics Nodes at Northwestern University.
All nf-core pipelines have been successfully configured for use on the Quest Genomics Nodes at Northwestern University. Note that, at present, this config has only been tested with nf-core/RNA-seq, but should function similarly for other nf-core pipelines. If you would like to test other pipelines and share on the genomics-rcs Slack, we would be very much obliged.
To use, run the pipeline with `-profile nu_genomics`. This will download and launch the [`nu_genomics.config`](../conf/nu_genomics.config) which has been pre-configured with a setup suitable for the Quest Genomics Nodes. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline.
@ -22,6 +22,14 @@ Note that you may need to install an "edge" version of Nextflow, depending on wh
curl -s https://github.com/nextflow-io/nextflow/releases/download/v20.11.0-edge/nextflow-20.11.0-edge-all | bash
```
Note that while the config does explicitly load the necessary modules, you will often need to load them manually anyway. Please do so before each run as follows, or you may run into errors:
```bash
module purge
module load singularity/latest
module load graphviz/2.40.1
```
## Use of iGenomes
A local copy of the iGenomes resource with all commonly used genomes has been made available for all of Quest so you should be able to run the pipeline against any reference available in the `igenomes.config` specific to the nf-core pipeline.