Skip to content
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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented Sep 25, 2024

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?

Copy link

netlify bot commented Sep 25, 2024

Deploy Preview for nf-core-main-site ready!

Name Link
🔨 Latest commit b9e70ae
🔍 Latest deploy log https://app.netlify.com/sites/nf-core-main-site/deploys/66f40ccab7fadd0008e18d9b
😎 Deploy Preview https://deploy-preview-2739--nf-core-main-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@christopher-hakkaart christopher-hakkaart self-assigned this Sep 25, 2024
@@ -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
Copy link
Member

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

Comment on lines +92 to +93
custom_config_version = 'master'
custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}"
Copy link
Member

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

Suggested change
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants