-
Notifications
You must be signed in to change notification settings - Fork 742
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
fix-meta-liniting #3352
fix-meta-liniting #3352
Conversation
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.
Nice, I think that two of the types should be maintained as boolean
but maybe there is a reason to change it that is unknow to me
@@ -28,12 +28,12 @@ input: | |||
type: directory | |||
description: Kraken2 database | |||
- save_output_fastqs: | |||
type: boolean | |||
type: string |
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.
Is this not a boolean?
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.
we don't have boolean as a type, see (https://nf-co.re/docs/contributing/modules#documentation point 8). Not sure if that is a nextflow limitation (I would be for it)
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 see that the PR is now closed, but I wanted to clarify this point anyway. I checked the modules repo and when I searched for type: boolean
there are 72 occurrences in meta.yml
s files both in modules and subworkflows. So if this is not allowed we should get rid of them. When you say this is a nextflow limitation what do you mean exactly? Thanks!
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.
ya i see those 72 too....i think we will have to change those too but,I am also curious as to why boolean is not supported @mashehu . now that we specify as string, will providing "true"
be the same as true
?
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.
was just going off of the guidelines, which I think @jfy133 worked on.
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.
But since we don't validate these types anywhere (besides in json-schema for meta.yml) and don't use them anywhere AFAIK (besides rendering them on the website), I am all for adding boolean
as a type to the guidelines.
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.
We should have a boolean! This documenation was added was before allowing non-file inputs :)
(docs also describe outputs which is why we have other types, but I've never heard of an boolean ouput)
Please add, as a new category rather than astring!
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.
We had it already in the schema, added it also to the guidelines now: https://github.com/nf-core/nf-co.re/pull/1767/files
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.
will tools also need an update? as linting with boolean fails
description: | | ||
If true, optional commands are added to save classified and unclassified reads | ||
as fastq files | ||
- save_reads_assignment: | ||
type: boolean | ||
type: string |
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.
Same here
Merged into PR #3344 and then merged into Thanks @sateeshperi ! |
PR checklist
Closes #XXX
versions.yml
file.label
PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware