search

nf-core / ampliseq

Amplicon sequencing analysis workflow using DADA2 and QIIME2
https://nf-co.re/ampliseq
MIT License
182 stars 115 forks source link

Documentation error: "Metadata files are not required to have additional metadata columns" #592

Closed d4straub closed 1 year ago

d4straub commented 1 year ago

Description of the bug

The description "Metadata files are not required to have additional metadata columns" in https://nf-co.re/ampliseq/dev/parameters#metadata is wrong. Report in nf-core clack channel ampliseq:

I read "Metadata files are not required to have additional metadata columns, so a file containing only an ID column is a valid QIIME 2 metadata file" and thought it would make my run work just fine. I even spent time validating the single column metadata file was correct. Then added the numeric column (still go the error as it was removed, leaving only the 'valid' single column of IDs), then finally got to the idea of making the column non-numeric (prepended a character to the numbers). I think it could be a lot more clear if someone is trying to run with a metadata file that is very barebones.

Command used and terminal output

No response

Relevant files

No response

System information

No response

d4straub commented 1 year ago

I changed the documentation but it might be best to actually have a metadata test with proper feedback (e.g. "ERROR: no proper column with non-numeric, non-unique entries found"). That is for another time though.