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

Documentation and file type for SampleSheet.csv #90

Open
mschubert opened this issue Feb 2, 2023 · 3 comments · Fixed by #236
Open

Documentation and file type for SampleSheet.csv #90

mschubert opened this issue Feb 2, 2023 · 3 comments · Fixed by #236
Labels
enhancement Improvement for existing functionality

Comments

@mschubert
Copy link

Description of feature

This is related to #81, which states (but is not the main concern of the linked issue)

Also https://raw.githubusercontent.com/nf-core/test-datasets/demultiplex/testdata/MiSeq/SampleSheet.csv doesn't seem like proper csv to me.

Would it be possible to add some documentation on how to write such a SampleSheet.csv file, and (probably) fix the extension to TOML?

I tried to look for it on https://nf-co.re/demultiplex/1.1.0/usage, but there was no mention of this.

@mschubert mschubert added the enhancement Improvement for existing functionality label Feb 2, 2023
@edmundmiller
Copy link
Collaborator

Is it a TOML though?

@mschubert
Copy link
Author

Well, also not really. Hence the probably and the question mark.

But the more important part is that reading the usage documentation, I've got no idea how to write such a file. To get some more info there would be great!

Btw, great that you're maintaining this pipeline! 👍 I'd love to use it.

@edmundmiller
Copy link
Collaborator

It's an Illumina "Samplesheet" https://support-docs.illumina.com/SW/BCL_Convert/Content/SW/BCLConvert/SampleSheets_swBCL.htm

So I think linking to those docs would solve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement for existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants