Improvement Description
More concise error handling within q2-demux for metadata file handling when running qiime demux emp-single to include the specific column where any metadata.tsv (or sequences.qza) errors occurred. This will make troubleshooting easier for both QIIME 2 users and developers.
Current Behavior
When an error originates from an issue within the metadata file provided (that is due to invalid characters present in the --m-barcodes-column), the following message is provided to the QIIME 2 user:
Plugin error from demux:
Invalid characters in sequence: ['1', '3', 'F', 'P', 'i', 'l'].
Valid characters: ['C', 'M', 'G', 'W', '-', 'H', 'T', 'K', 'S', 'Y', 'B', 'A', 'N', 'D', 'V', 'R', '.']
Note: Use `lowercase` if your sequence contains lowercase characters not in the sequence's alphabet.
Proposed Behavior
The error above will also include a q2-demux specific message that includes the column name that caused the error, along with suggested resolution (make sure you've included the correct column in your metadata file, etc).
Improvement Description More concise error handling within q2-demux for metadata file handling when running qiime demux emp-single to include the specific column where any metadata.tsv (or sequences.qza) errors occurred. This will make troubleshooting easier for both QIIME 2 users and developers.
Current Behavior When an error originates from an issue within the metadata file provided (that is due to invalid characters present in the --m-barcodes-column), the following message is provided to the QIIME 2 user:
This is an error message pulled from scikitbio, but there is no specific error message from q2-demux.
Proposed Behavior The error above will also include a q2-demux specific message that includes the column name that caused the error, along with suggested resolution (make sure you've included the correct column in your metadata file, etc).
References QIIME 2 Forum post that prompted this improvement