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

Strict validation of input samplesheet.csv #7

Open
jannikseidelQBiC opened this issue Mar 20, 2024 · 1 comment
Open

Strict validation of input samplesheet.csv #7

jannikseidelQBiC opened this issue Mar 20, 2024 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@jannikseidelQBiC
Copy link

Following feature would be beneficial in the future:

  • The headers of the samplesheet should be able to be validated in strict mode, meaning if they are misspelled or missing the pipelines should throw an error instead of a warning
  • This behavior should be able to be turned on or off

The same feature would be nice for entries in the samplesheet, where required fields are missing.

e.g. if following samplesheet would be present

sample,short_reads_fastq_1,short_reads_fastq_2,long_reads_fastq_2
test,,path/to/first_fastq.gz,

and should be formatted like this

sample,short_reads_fastq_1,short_reads_fastq_2,long_reads_fastq_1
test,path/to/first_fastq.gz,,

and either short_reads_fastq_1 or long_reads_fastq_1are required fields

The pipeline should fail and not run empty with warnings. Also a meaningful error should be thrown in such a scenario.

It would be best this could be turned on or off in a schema_input.json.

@nvnieuwk nvnieuwk transferred this issue from nextflow-io/nf-validation Apr 23, 2024
@nvnieuwk nvnieuwk added this to the 2.1.0 milestone Apr 23, 2024
@nvnieuwk
Copy link
Collaborator

The best solution for this is to create a new configuration option (validation.strictHeaders for example). This can then be turned on to throw errors instead of warnings for unknown headers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants