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

INPUT VALIDATION: what to do with unsupported and harmful flags of aligners modules? #74

Closed
alessiovignoli opened this issue Oct 18, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request ready ready in some branch - waiting to be merged.
Milestone

Comments

@alessiovignoli
Copy link
Contributor

Description of feature

There are some flags that the user is able to specify from the samplesheet.csv that might be annoying for the pipeline (unsupported).
Some other flags do even brack the pipeline in itself, for example we would want the aligners not to compress the output as of today. So if the user passes the flag to do so it is likely going to breack the pipeline.

The question is the following. How to deal with this harmfull flags?.

This should be where the ideas are brainstormed.

@alessiovignoli alessiovignoli added the enhancement New feature or request label Oct 18, 2023
@luisas luisas changed the title what to do with unsupported and harmfull flags of aligners modules? INPUT VALIDATION: what to do with unsupported and harmful flags of aligners modules? Oct 18, 2023
@luisas luisas added this to the version 1.1 milestone Dec 14, 2023
@luisas
Copy link
Collaborator

luisas commented Dec 19, 2023

This should be done in the validation of the toolsheet at the beginning of the pipeline.

  • Add minimal flags as default if not given (example: 3Dcoffee should not be allowed to run without a structural method, same as regressive without the -reg flag)
  • Reference in documentation where one can find the optional extra flags.

SO: we need to make sure the minimal ones are always present, no need to check for optional flags, those are responsibility of the user but describe well in documentation.

@luisas luisas self-assigned this Dec 19, 2023
@luisas
Copy link
Collaborator

luisas commented Dec 19, 2023

I made a custom validation in the WorkflowMultiplesequencealign.groovy file.

there is an open issue in nf-validation, when they enable it, we can update it.

For the moment, this is it with the input validation i'd say.

==> Closed by #93

@luisas luisas added the ready ready in some branch - waiting to be merged. label Dec 19, 2023
@luisas luisas closed this as completed Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ready ready in some branch - waiting to be merged.
Projects
None yet
Development

No branches or pull requests

2 participants