millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-12-24 02:58:17 +00:00
Code Issues Releases Packages Activity

better docs and organisation of giles

Browse source
This commit is contained in:
MaxUlysse 2020-04-09 17:02:36 +02:00
parent 6adc7342e9
commit 50a44d037b
4 changed files with 36 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -15,6 +15,7 @@ A repository for hosting Nextflow configuration files containing custom paramete
* [Documentation](#documentation)
* [Uploading to `nf-core/configs`](#uploading-to-nf-coreconfigs)
* [Adding a new pipeline-specific config](#adding-a-new-pipeline-specific-config)
* [Pipeline-specific institutional documentation](#pipeline-specific-institutional-documentation)
* [Pipeline-specific documentation](#pipeline-specific-documentation)
* [Enabling pipeline-specific configs within a pipeline](#enabling-pipeline-specific-configs-within-a-pipeline)
* [Create the pipeline-specific `nf-core/configs` files](#create-the-pipeline-specific-nf-coreconfigs-files)
@ -159,9 +160,9 @@ Each configuration file will add new params and overwrite the params already exi
Note that pipeline-specific configs are not required and should only be added if needed.
### Pipeline-specific documentation
### Pipeline-specific institutional documentation
Currently documentation is available for the following pipeline within the specific profile:
Currently documentation is available for the following pipelines within specific profiles:
* ampliseq
* [BINAC](docs/pipeline/ampliseq/binac.md)
@ -174,6 +175,13 @@ Currently documentation is available for the following pipeline within the speci
* [MUNIN](docs/pipeline/sarek/munin.md)
* [UPPMAX](docs/pipeline/sarek/uppmax.md)
### Pipeline-specific documentation
Currently documentation is available for the following pipeline:
* viralrecon
* [genomes](docs/pipeline/viralrecon/genomes.md)
### Enabling pipeline-specific configs within a pipeline
:warning: **This has to be done on a fork of the `nf-core/<PIPELINE>` repository.**

16
conf/pipeline/viralrecon/genomes.config Normal file
View file

@ -0,0 +1,16 @@
/*
* -------------------------------------------------
* nfcore/viralrecon custom profile Nextflow config file
* -------------------------------------------------
* Defines viral reference genomes for all environments.
*/
params {
// Genome reference file paths
genomes {
'NC_045512.2' {
fasta = "https://raw.githubusercontent.com/nf-core/test-datasets/viralrecon/genome/NC_045512.2/NC_045512.2.fasta.gz"
gff = "https://raw.githubusercontent.com/nf-core/test-datasets/viralrecon/genome/NC_045512.2/NC_045512.2.gff.gz"
}
}
}

9
docs/pipeline/viralrecon/genomes.md Normal file
View file

@ -0,0 +1,9 @@
# nf-core/configs: viralrecon specific configuration
Extra specific configuration for viralrecon pipeline
## Usage
Will be used automatically when running the pipeline with the shared configs in the nf-core/configs repository
This will download and launch the viralrecon specific [`viralrecon.config`](../../../conf/pipeline/viralrecon/genomes.config) which has been pre-configured with custom genomes.

11
pipeline/viralrecon.config
View file

@ -2,15 +2,6 @@
* -------------------------------------------------
* nfcore/viralrecon custom profile Nextflow config file
* -------------------------------------------------
* Defines viral reference genomes for all environments.
*/
params {
// Genome reference file paths
genomes {
'NC_045512.2' {
fasta = "https://raw.githubusercontent.com/nf-core/test-datasets/viralrecon/genome/NC_045512.2/NC_045512.2.fasta.gz"
gff = "https://raw.githubusercontent.com/nf-core/test-datasets/viralrecon/genome/NC_045512.2/NC_045512.2.gff.gz"
}
}
}
includeConfig "${params.custom_config_base}/conf/pipeline/viralrecon/genomes.config" }