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

revert * to - changes

Browse source
This commit is contained in:
MaxUlysse 2020-03-11 15:39:36 +01:00
parent d4bea56f52
commit 6be1716797
1 changed files with 40 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
README.md
View file

@ -93,33 +93,33 @@ See [`nf-core/configs/docs`](https://github.com/nf-core/configs/tree/master/docs
Currently documentation is available for the following systems: Currently documentation is available for the following systems:
- [AWSBATCH](docs/awsbatch.md) * [AWSBATCH](docs/awsbatch.md)
- [BIGPURPLE](docs/bigpurple.md) * [BIGPURPLE](docs/bigpurple.md)
- [BINAC](docs/binac.md) * [BINAC](docs/binac.md)
- [CBE](docs/cbe.md) * [CBE](docs/cbe.md)
- [CCGA_DX](docs/ccga_dx.md) * [CCGA_DX](docs/ccga_dx.md)
- [CCGA_MED](docs/ccga_med.md) * [CCGA_MED](docs/ccga_med.md)
- [CFC](docs/cfc.md) * [CFC](docs/cfc.md)
- [CRICK](docs/crick.md) * [CRICK](docs/crick.md)
- [CZBIOHUB_AWS](docs/czbiohub.md) * [CZBIOHUB_AWS](docs/czbiohub.md)
- [CZBIOHUB_AWS_HIGHPRIORITY](docs/czbiohub.md) * [CZBIOHUB_AWS_HIGHPRIORITY](docs/czbiohub.md)
- [DENBI_QBIC](docs/denbi_qbic.md) * [DENBI_QBIC](docs/denbi_qbic.md)
- [EBC](docs/ebc.md) * [EBC](docs/ebc.md)
- [GENOTOUL](docs/genotoul.md) * [GENOTOUL](docs/genotoul.md)
- [GENOUEST](docs/genouest.md) * [GENOUEST](docs/genouest.md)
- [GIS](docs/gis.md) * [GIS](docs/gis.md)
- [GOOGLE](docs/google.md) * [GOOGLE](docs/google.md)
- [HEBBE](docs/hebbe.md) * [HEBBE](docs/hebbe.md)
- [KRAKEN](docs/kraken.md) * [KRAKEN](docs/kraken.md)
- [MUNIN](docs/munin.md) * [MUNIN](docs/munin.md)
- [PASTEUR](docs/pasteur.md) * [PASTEUR](docs/pasteur.md)
- [PHOENIX](docs/phoenix.md) * [PHOENIX](docs/phoenix.md)
- [PRINCE](docs/prince.md) * [PRINCE](docs/prince.md)
- [SHH](docs/shh.md) * [SHH](docs/shh.md)
- [UCT_HEX](docs/uct_hex.md) * [UCT_HEX](docs/uct_hex.md)
- [UPPMAX](docs/uppmax.md) * [UPPMAX](docs/uppmax.md)
- [UTD_GANYMEDE](docs/utd_ganymede.md) * [UTD_GANYMEDE](docs/utd_ganymede.md)
- [UZH](docs/uzh.md) * [UZH](docs/uzh.md)
### Uploading to `nf-core/configs` ### Uploading to `nf-core/configs`
@ -163,15 +163,15 @@ Note that pipeline-specific configs are not required and should only be added if
Currently documentation is available for the following pipeline within the specific profile: Currently documentation is available for the following pipeline within the specific profile:
- ampliseq * ampliseq
- [BINAC](docs/pipeline/ampliseq/binac.md) * [BINAC](docs/pipeline/ampliseq/binac.md)
- eager * eager
- [SHH](docs/pipeline/eager/shh.md) * [SHH](docs/pipeline/eager/shh.md)
- rnafusion * rnafusion
- [MUNIN](docs/pipeline/rnafusion/munin.md) * [MUNIN](docs/pipeline/rnafusion/munin.md)
- sarek * sarek
- [MUNIN](docs/pipeline/sarek/munin.md) * [MUNIN](docs/pipeline/sarek/munin.md)
- [UPPMAX](docs/pipeline/sarek/uppmax.md) * [UPPMAX](docs/pipeline/sarek/uppmax.md)
### Enabling pipeline-specific configs within a pipeline ### Enabling pipeline-specific configs within a pipeline
@ -200,7 +200,7 @@ We will be notified automatically when you have created your pull request, and p
[Fork](https://help.github.com/articles/fork-a-repo/) the [`nf-core/configs`](https://github.com/nf-core/configs/) repository to your own GitHub account. [Fork](https://help.github.com/articles/fork-a-repo/) the [`nf-core/configs`](https://github.com/nf-core/configs/) repository to your own GitHub account.
And add or edit the following files in the local clone of your fork. And add or edit the following files in the local clone of your fork.
- `pipeline/<PIPELINE>.config` * `pipeline/<PIPELINE>.config`
If not already created, create the `pipeline/<PIPELINE>.config` file, and add your custom profile to the profile scope If not already created, create the `pipeline/<PIPELINE>.config` file, and add your custom profile to the profile scope
@ -210,18 +210,18 @@ profiles {
} }
``` ```
- `conf/pipeline/<PIPELINE>/<PROFILE>.config` * `conf/pipeline/<PIPELINE>/<PROFILE>.config`
Add the custom configuration file to the `conf/pipeline/<PIPELINE>/` directory. Add the custom configuration file to the `conf/pipeline/<PIPELINE>/` directory.
Make sure to add an extra `params` section with `params.config_profile_description`, `params.config_profile_contact` to the top of `pipeline/<PIPELINE>.config` and set to reasonable values. Make sure to add an extra `params` section with `params.config_profile_description`, `params.config_profile_contact` to the top of `pipeline/<PIPELINE>.config` and set to reasonable values.
Users will get information on who wrote the pipeline-specific configuration profile then when executing the nf-core pipeline and can report back if there are things missing for example. Users will get information on who wrote the pipeline-specific configuration profile then when executing the nf-core pipeline and can report back if there are things missing for example.
- `docs/pipeline/<PIPELINE>/<PROFILE>.md` * `docs/pipeline/<PIPELINE>/<PROFILE>.md`
Add the documentation file to the `docs/pipeline/<PIPELINE>/` directory. Add the documentation file to the `docs/pipeline/<PIPELINE>/` directory.
You will also need to edit and add your custom profile to the [`README.md`](https://github.com/nf-core/configs/blob/master/README.md) file in the top-level directory of the clone. You will also need to edit and add your custom profile to the [`README.md`](https://github.com/nf-core/configs/blob/master/README.md) file in the top-level directory of the clone.
- `README.md` * `README.md`
Edit this file, and add the new pipeline-specific institutional profile to the list in the section Pipeline specific documentation Edit this file, and add the new pipeline-specific institutional profile to the list in the section Pipeline specific documentation