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

Blog: Tweak config examples #115

Merged
merged 3 commits into from May 25, 2023
Merged

Blog: Tweak config examples #115

merged 3 commits into from May 25, 2023

Conversation

ewels
Copy link
Member

@ewels ewels commented May 25, 2023

I personally found the mix of configuration within script process blocks and config process scopes confusing. We always say that it's best practice to never specify this stuff within a script, but always do it in a config file - that way it's easier to overwrite and make the pipeline portable. As such, I updated the examples to all use only configs and not script syntax.

One or two other minor tweaks.

@ewels ewels requested a review from pditommaso May 25, 2023 12:21
@netlify
Copy link

netlify bot commented May 25, 2023

Deploy Preview for nextflow-staging ready!

Name Link
🔨 Latest commit 3b14a36
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-staging/deploys/646f563b6e8cdc0008040cb3
😎 Deploy Preview https://deploy-preview-115--nextflow-staging.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 settings.

@GJSissons
Copy link

Thanks for these corrections, @ewels. The changes look good to me. I can see where it makes more sense to specify the settings in the config file. I notice in the documentation settings often appear in the process block in the workflow itself, but maybe this is just for ease of explanation, or these haven't been updated yet. https://nextflow.io/docs/latest/process.html#process-cpus

@ewels
Copy link
Member Author

ewels commented May 25, 2023

Yeah, that's because they are process directives - so they sit in the documentation for processes. The config docs just says "you can do all the process directives". It's not wrong to do it in the process, just that we typically don't consider it best practice.

Copy link
Member Author

@ewels ewels left a comment

Choose a reason for hiding this comment

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

@GJSissons NB couple of other more subtle changes highlighted 👇🏻

@@ -327,8 +321,7 @@ $ cat submit_pipeline.sh
#BSUB -e err.%J
#BSUB -J headjob
#BSUB -R "rusage[mem=16GB]"
export NFX_OPTS="-Xms=512m -Xmx=8g"
Copy link
Member Author

Choose a reason for hiding this comment

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

Removed as this isn't explained until the following section. Alternatively could reorder the sections, or just leave it here without explanation is probably fine too.

@ewels ewels merged commit 6af06d5 into master May 25, 2023
5 checks passed
@ewels ewels deleted the blog-hpc-tweaks branch May 26, 2023 17:28
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.

None yet

3 participants