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

fix-meta-liniting #3352

Closed
wants to merge 2 commits into from
Closed

fix-meta-liniting #3352

wants to merge 2 commits into from

Conversation

sateeshperi
Copy link
Contributor

PR checklist

Closes #XXX

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • 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

@sateeshperi sateeshperi requested a review from ewels April 28, 2023 22:49
modules/nf-core/cat/fastq/meta.yml Outdated Show resolved Hide resolved
Copy link
Member

@JoseEspinosa JoseEspinosa left a 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
Copy link
Member

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?

Copy link
Contributor

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)

Copy link
Member

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.ymls 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!

Copy link
Contributor Author

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 ?

Copy link
Contributor

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.

Copy link
Contributor

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.

Copy link
Member

@jfy133 jfy133 May 3, 2023

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!

Copy link
Contributor

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

Copy link
Contributor Author

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
Copy link
Member

Choose a reason for hiding this comment

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

Same here

@ewels
Copy link
Member

ewels commented May 2, 2023

Merged into PR #3344 and then merged into master in b9829e1.

Thanks @sateeshperi !

@ewels ewels closed this May 2, 2023
@sateeshperi sateeshperi deleted the fix/v2.8-meta-linting-errors branch May 2, 2023 15:15
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.

6 participants