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

BUG: better error handling for differing index names when running merge #63

Closed
lizgehret opened this issue Dec 5, 2023 · 1 comment · Fixed by #64
Closed

BUG: better error handling for differing index names when running merge #63

lizgehret opened this issue Dec 5, 2023 · 1 comment · Fixed by #64
Assignees

Comments

@lizgehret
Copy link
Member

Bug Description
When running merge on two different metadata files with different index names (i.e. sample-id and ID), the following error message is produced:

Screen Shot 2023-12-05 at 2 32 25 PM

This provides little to no clarification regarding the issue being different index names (vs. the index name being set to None).

Steps to reproduce the behavior

  1. Go to the Moving Pictures tutorial and download sample-metadata.tsv

  2. Duplicate the sample-metadata.tsv file and save it as two different files (e.g. sample-md1.tsv & sample-md2.tsv)

  3. Within one of the duplicated files, modify the index name (e.g. ID)

  4. Run the following command:

qiime metadata merge \
--m-metadata1-file sample-md1.tsv \
--m-metadata2-file sample-md2.tsv \
--o-merged-metadata merged-md.qza \
--verbose

This will produce the error in the screenshot above.

Expected behavior
A new error should be raised that will check for matching index names within the two metadata files, so that the error above is handled with a message that is more informative to the user. Additionally, the help text for this method should include one or two sentences regarding index names needing to match.

@lizgehret
Copy link
Member Author

Last one for now @hagenjp - these should all keep you busy for a while 🙂

@lizgehret lizgehret added this to 2024.5 May 1, 2024
@github-project-automation github-project-automation bot moved this to Backlog in 2024.5 May 1, 2024
@lizgehret lizgehret moved this from Backlog to Changelog Needed in 2024.5 May 1, 2024
@hagenjp hagenjp moved this from Changelog Needed to Completed in 2024.5 May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Completed
Development

Successfully merging a pull request may close this issue.

2 participants