-
Notifications
You must be signed in to change notification settings - Fork 187
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecate checkmax/max_params docs #2739
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@@ -40,7 +40,7 @@ | |||
/docs/usage/offline https://nf-core-docs.netlify.app/docs/usage/getting_started/offline 200 | |||
/docs/usage/troubleshooting https://nf-core-docs.netlify.app/docs/usage/troubleshooting/overview 200 | |||
/docs/usage/tutorials https://nf-core-docs.netlify.app/docs/tutorials 200 | |||
/docs/usage/tutorials/step_by_step_institutional_profile https://nf-core-docs.netlify.app/docs/tutorials/use_nf-core_pipelines/config_institutional_profile 200 | |||
/docs/usage/tutorials/step_by_step_institutional_profile https://nf-core-docs.netlify.app/docs/tutorials/use_nf-core_pipelines/writing_institutional_profile 200 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should also add a new redirection rule as well if we are removing /config_institutional_profile
custom_config_version = 'master' | ||
custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would write the params
scope or write it as params.custom_config_version
to make it clear
custom_config_version = 'master' | |
custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}" | |
params { | |
custom_config_version = 'master' | |
custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}" | |
} |
|
||
For a more sophisticated `base.config`, see the full [nf-core template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/conf/base.config) | ||
|
||
2. In a top level `nextflow.config`, specify two `param` to specify the URL where to look for nf-core/configs from. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. In a top level `nextflow.config`, specify two `param` to specify the URL where to look for nf-core/configs from. | |
2. In a top level `nextflow.config`, specify two `params` to specify the URL where to look for nf-core/configs from. |
} | ||
``` | ||
|
||
And supply this in your pipeline run command with `-c <custom>.conf`. Then, during a pipeline run, if for example a job exceeds the default memory request, it will be retried increasing the memory each time until either the job completes, or until it reaches a request of `256.GB`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And supply this in your pipeline run command with `-c <custom>.conf`. Then, during a pipeline run, if for example a job exceeds the default memory request, it will be retried increasing the memory each time until either the job completes, or until it reaches a request of `256.GB`. | |
And supply this in your pipeline run command with `-c <custom>.config`. Then, during a pipeline run, if for example a job exceeds the default memory request, it will be retried increasing the memory each time until either the job completes, or until it reaches a request of `256.GB`. |
It would be great someone can do a double check we've not left anything in.
We should also think about when this PR should be merged in... is it OK to do this now or should we sync with the tools update/release?