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

Workflow name #2

Closed
elizabethmcd opened this issue Oct 12, 2022 · 3 comments
Closed

Workflow name #2

elizabethmcd opened this issue Oct 12, 2022 · 3 comments

Comments

@elizabethmcd
Copy link
Contributor

Potentially change repo and workflow name to just metagenomics-nf as when you run with nextflow run Arcadia-Science/arcadia-metagenomic-assembly-nf .... the Arcadia part is redundant in the repo/workflow name. However if you clone the repository and run with nextflow run main.nf then the repo name would just be metagenomics-nf.

It depends on what the suggested "quick start" run should be, as not requiring git clone is a faster start. Forking or cloning would more suggest that somebody is contributing changes to the pipeline and not running it persay.

The other issue is if metagenomics-nf alone is enough description, as this just covers the QC, assembly, and evaluation of metagenomic reads/assembly. It doesn't imply subsequent binning for example, which would be a separate workflow binning-nf for example under this nomenclature strategy.

@taylorreiter thoughts?

@taylorreiter
Copy link
Member

what about metagenomics-assembly-nf? Then subsequent pipelines could include key words for what those things do (e.g. metagenomics-binning-nf and metagenomes-annotation-nf).

I agree that arcadia is redundant. I would prefer if the suggested quickstart does not involve git clone. That gets really cumbersome when the nf workflow is only one piece of a larger analysis. However, I'm still new to running nf pipelines so it's hard for me to have strong opinions here.

@elizabethmcd
Copy link
Contributor Author

Ok I agree on metagenomics-assembly-nf for this one and metagenomics-binning-nf for the subsequent workflow. I think I will keep annotation as microbial-annotation-nf so it's clear you can input a microbial genome from any source (isolate or MAG)

@elizabethmcd
Copy link
Contributor Author

Workflow name is changed to metagenomics to be all lower case, and one word with no punctuation. This conforms to nf-core practices when creating and naming pipelines with nf-core create, according to issues nf-core/tools#85 and nf-core/tools#1822

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

No branches or pull requests

2 participants