millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-25 17:29:55 +00:00
Code Issues Releases Packages Activity

Merge pull request #94 from apeltzer/master

Browse source 
Mini Cosmetic Fixes for README
This commit is contained in:
Alexander Peltzer 2019-11-26 16:24:30 +01:00 committed by GitHub
commit ee99d7f2d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,22 +1,21 @@
# [![nf-core/configs](docs/images/nfcore-configs_logo.png)](https://github.com/nf-core/configs) # [![nf-core/configs](docs/images/nfcore-configs_logo.png "nf-core/configs")](https://github.com/nf-core/configs)
[![Lint Status](https://github.com/nf-core/configs/workflows/nfcore%20configs%20tests/badge.svg)](https://github.com/nf-core/configs/workflows/nfcore%20configs%20tests/badge.svg) [![Lint Status](https://github.com/nf-core/configs/workflows/Configs%20tests/badge.svg)](https://github.com/nf-core/configs/workflows/Configs%20tests/badge.svg)
A repository for hosting nextflow config files containing custom parameters required to run nf-core pipelines at different Institutions. A repository for hosting nextflow config files containing custom parameters required to run nf-core pipelines at different Institutions.
## Table of contents ## Table of contents
* [![nf-core/configs](https://github.com/nf-core/configs)](#nf-coreconfigshttpsgithubcomnf-coreconfigs) * [Table of contents](#table-of-contents)
* [Table of contents](#table-of-contents) * [Using an existing config](#using-an-existing-config)
* [Using an existing config](#using-an-existing-config) * [Configuration and parameters](#configuration-and-parameters)
* [Configuration and parameters](#configuration-and-parameters) * [Offline usage](#offline-usage)
* [Offline usage](#offline-usage) * [Adding a new config](#adding-a-new-config)
* [Adding a new config](#adding-a-new-config) * [Checking user hostnames](#checking-user-hostnames)
* [Checking user hostnames](#checking-user-hostnames) * [Testing](#testing)
* [Testing](#testing) * [Documentation](#documentation)
* [Documentation](#documentation) * [Uploading to `nf-core/configs`](#uploading-to-nf-coreconfigs)
* [Uploading to `nf-core/configs`](#uploading-to-nf-coreconfigs) * [Help](#help)
* [Help](#help)
## Using an existing config ## Using an existing config
@ -116,7 +115,7 @@ Currently documentation is available for the following systems:
[Fork](https://help.github.com/articles/fork-a-repo/) the `nf-core/configs` repository to your own GitHub account. Within the local clone of your fork add the custom config file to the [`conf/`](https://github.com/nf-core/configs/tree/master/conf) directory, and the documentation file to the [`docs/`](https://github.com/nf-core/configs/tree/master/docs) directory. You will also need to edit and add your custom profile to the [`nfcore_custom.config`](https://github.com/nf-core/configs/blob/master/nfcore_custom.config) file in the top-level directory of the clone. [Fork](https://help.github.com/articles/fork-a-repo/) the `nf-core/configs` repository to your own GitHub account. Within the local clone of your fork add the custom config file to the [`conf/`](https://github.com/nf-core/configs/tree/master/conf) directory, and the documentation file to the [`docs/`](https://github.com/nf-core/configs/tree/master/docs) directory. You will also need to edit and add your custom profile to the [`nfcore_custom.config`](https://github.com/nf-core/configs/blob/master/nfcore_custom.config) file in the top-level directory of the clone.
Afterwards, make sure to edit the `.github/main.yml` file and add your profile name to alphabetically sorted `profile:` scope. This way, it will be tested automatically using GitHub Actions. Afterwards, make sure to edit the `.github/main.yml` file and add your profile name to the alphabetically sorted `profile:` scope. This way, it will be tested automatically using GitHub Actions. If you forget to do this, tests will fail and complain about that.
Commit and push these changes to your local clone on GitHub, and then [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) on the `nf-core/configs` GitHub repo with the appropriate information. Commit and push these changes to your local clone on GitHub, and then [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) on the `nf-core/configs` GitHub repo with the appropriate information.

2
bin/cchecker.py
View file

@ -64,7 +64,7 @@ def check_config(Config, Github):
sys.exit(0) sys.exit(0)
else: else:
#Maybe report what is missing here too #Maybe report what is missing here too
print("Tests don't seem to test these profiles properly!\n") print("Tests don't seem to test these profiles properly. Please check whether you added the profile to the Github Actions testing YAML.\n")
print(config_profiles.symmetric_difference(tests)) print(config_profiles.symmetric_difference(tests))
sys.exit(1) sys.exit(1)

1
conf/genotoul.config
View file

@ -19,6 +19,7 @@ process {
params { params {
save_reference = true save_reference = true
igenomes_ignore = true igenomes_ignore = true
igenomesIgnore = true //deprecated
// Max resources requested by a normal node on genotoul. // Max resources requested by a normal node on genotoul.
max_memory = 120.GB max_memory = 120.GB
max_cpus = 48 max_cpus = 48