Skip to content

Commit

Permalink
Moved custom Institutional configs to nf-core configs on github
Browse files Browse the repository at this point in the history
  • Loading branch information
Harshil Patel committed Nov 24, 2018
1 parent 3d0a6f4 commit b9d9c58
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 27 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# nf-core/tools: Changelog

## v1.3dev
* Institutional custom config profiles moved to github `nf-core/configs`
* These will now be maintained centrally as opposed to being shipped with the pipelines in `conf/`
* Load `base.config` by default for all profiles
* Removed profiles named `standard` and `none`
* Added parameter `--igenomesIgnore` so `igenomes.config` isnt loaded if parameter clashes are observed
* Added parameter `--custom_config_version` for custom config version control. Can use this parameter to provide commit id for reproducibility. Defaults to `master`

##[v1.3](https://github.com/nf-core/tools/releases/tag/1.3) - 2018-11-21
* `nf-core create` command line interface updated
* Interactive prompts for required arguments if not given
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,46 +32,34 @@ params {
clusterOptions = false
awsqueue = false
awsregion = 'eu-west-1'
igenomesIgnore = false
custom_config_version = 'master'
}

// Load base.config by default for all pipelines
includeConfig 'conf/base.config'

// Load nf-core custom profiles from different Institutions
includeConfig "https://github.com/nf-core/configs/${params.custom_config_version}/nfcore_custom.config"

profiles {
awsbatch {
includeConfig 'conf/base.config'
includeConfig 'conf/awsbatch.config'
includeConfig 'conf/igenomes.config'
}
binac {
includeConfig 'conf/base.config'
includeConfig 'conf/binac.config'
}
cfc {
includeConfig 'conf/base.config'
includeConfig 'conf/cfc.config'
}
awsbatch { includeConfig 'conf/awsbatch.config' }
conda { process.conda = "$baseDir/environment.yml" }
debug { process.beforeScript = 'echo $HOSTNAME' }
docker {
docker.enabled = true
process.container = params.container
}
none {
// Don't load any config (for use with custom home configs)
}
singularity {
singularity.enabled = true
process.container = {"shub://${params.container.replace('nfcore', 'nf-core')}"}
}
standard {
includeConfig 'conf/base.config'
}
test {
includeConfig 'conf/base.config'
includeConfig 'conf/test.config'
}
uzh {
includeConfig 'conf/base.config'
includeConfig 'conf/uzh.config'
}
test { includeConfig 'conf/test.config' }
}

// Load igenomes.config if required
if(!params.igenomesIgnore){
includeConfig 'conf/igenomes.config'
}

// Capture exit codes from upstream processes when piping
Expand Down

1 comment on commit b9d9c58

@drpatelh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering whether nfcore_custom.config needs to be under version control too or shall I just set it to master? Most importantly, will it work?!

includeConfig "https://github.com/nf-core/configs/${params.custom_config_version}/nfcore_custom.config"

Please sign in to comment.