Improve Samplesheet Documentation to Clarify Format Requirements and Prevent Common Errors

[MauriAndresMU1313]

Description of feature

Hello to all the team, thank you for provide this tool!
I would like to suggest some improvements to make this tool even better.

Description:

The current documentation for samplesheet creation is insufficient and leads to frequent user errors, particularly regarding the Sample ID format and structure.
I suggest to add a clear example with real file names. For example I added both of my R1 and R2 files from Illumina run, i was having issues related to out of range, repeat names, etc.

My point here is that be more explicit in the format, it will help a lot and will save time for the user.

Suggestion:

• Column names: use "_" to represent spaces. Something this can lead to issues.
• Missing Validation: No clear error messages explaining what's wrong with the samplesheet format, here you can add an example (with the error message).

I finally ran the tool with my samples, but after at least 10 tries.
Please add more documentation regarding Illumina or Nanopore.

Again, thank you for provide this tool!
Mauricio

[nbx0]

Thank you very much for these comments and suggestions, Mauricio!

We have also noted these issues and already have it on our road map to improve the fastq handling and validation error statements. We will also work to improve our documentation.

Good point on using _ instead of spaces, as well.

If you would like support on your current attempts, please reach out to us at idseqsupport@cdc.gov .

Sincerely,
Ben