search

carpentries-incubator / workflows-nextflow

Workflow management with Nextflow and nf-core
https://carpentries-incubator.github.io/workflows-nextflow/
Other
21 stars 34 forks source link

Coding practices episode #45

Closed mahesh-panchal closed 2 years ago

mahesh-panchal commented 2 years ago

An episode on coding practices. Should this be an episode, or scattered throughout the course?

mahesh-panchal commented 2 years ago

This looks like enough content for it's own page.

Needs more exercises though.

ggrimes commented 2 years ago

I agree, I would add this as a separate episode.

mahesh-panchal commented 2 years ago

Anything else you think should be added (or reordered)? Aside from some exercises?

sateeshperi commented 2 years ago

recommend encouraging users to add tag and labels to processes

mahesh-panchal commented 2 years ago

recommend encouraging users to add tag and labels to processes

@sateeshperi What are the benefits to this in terms of readability, maintainability, portability, reproducibility, or compute best practices? Usually only one tag value appears per process while the pipeline is running or complete. Can you explain further why this is useful? I'm also not sure what the clear benefit of using labels is in this context. What do you encourage?

sateeshperi commented 2 years ago

i thought enforcing them as we do in modules will help with debugging and config files....however as long as we cover them in the processes chapter they don't need to be in the best coding practices chapter

mahesh-panchal commented 2 years ago

I'll add in exercises later. Probably better to have the material in now.