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

feature request: print samplesheet format as part of --help #21

Open
cmatKhan opened this issue Aug 11, 2023 · 3 comments
Open

feature request: print samplesheet format as part of --help #21

cmatKhan opened this issue Aug 11, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@cmatKhan
Copy link

this is a very nice tool -- thank you!

Unless I am misunderstanding the docs, the samplesheet schema is not included when the user enters --help. Arguably, including it is too verbose for a help message, but I believe I would find it useful.

@mirpedrol mirpedrol added the enhancement New feature or request label Aug 29, 2023
@nvnieuwk
Copy link
Collaborator

Maybe a new function could be added that prints out the samplesheet, this way you can separate them from the summary. something called printSamplesheet for example

@cmatKhan
Copy link
Author

cmatKhan commented Oct 18, 2023

I'm thinking not the entire samplesheet, but rather just the field names and whether or not they are required. Something like:

Input samplesheet fields:

sample (required)
group (optional)
fastq_1 (required)
fastq_2 (optional)

Printing the whole samplesheet would definitely muddy the output.

The use case would be: a user has possibly used a workflow before, and vaguely remembers what the samplesheet fields are, but wants a quick confirmation from the cmd line

@nvnieuwk
Copy link
Collaborator

I agree that would be way better, thanks for the suggestion!

@nvnieuwk nvnieuwk transferred this issue from nextflow-io/nf-validation Apr 23, 2024
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

3 participants