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

Describe column name case insensitivity in metadata tutorial #577

Closed
AmandaBirmingham opened this issue Mar 15, 2024 · 1 comment · Fixed by #591
Closed

Describe column name case insensitivity in metadata tutorial #577

AmandaBirmingham opened this issue Mar 15, 2024 · 1 comment · Fixed by #591
Assignees
Labels
good first issue Good for newcomers

Comments

@AmandaBirmingham
Copy link

Improvement Description
Extend the metadata tutorial to explicitly note that non-id column names must differ by more than just case. See reference 1 below.

Current Behavior
Currently, the Metadata class allows instantiation with inputs containing column names that differ only by case, but this leads to an error if using the get_ids() method.

Proposed Behavior
Add a sentence to the metadata.rst tutorial. My suggestion is to modify

- Must be unique (exact string matching is performed to detect duplicates).

to

 - Must be unique without regard to case (e.g., columns `foo` and `Foo` in the same file are not allowed)

References

  1. https://forum.qiime2.org/t/are-non-sample-id-column-names-case-insensitive-in-metadata-files/29508
@github-project-automation github-project-automation bot moved this to Backlog in 2024.5 May 16, 2024
@cherman2 cherman2 moved this from Backlog to In Analysis in 2024.5 May 23, 2024
@hagenjp hagenjp moved this from In Analysis to In Development in 2024.5 May 23, 2024
@hagenjp
Copy link
Contributor

hagenjp commented May 23, 2024

Hi @AmandaBirmingham, we are looking into a solution for this one and its not as simple as we thought because this is not an intentional behavior within qiime2. I think we will want to find a better solution than just changing documentation. Many thanks for bringing this one to our attention!

@hagenjp hagenjp removed this from 2024.5 May 23, 2024
@github-project-automation github-project-automation bot moved this to Backlog in 2024.10 🎃 May 23, 2024
@hagenjp hagenjp moved this from Backlog to In Analysis in 2024.10 🎃 May 23, 2024
@lizgehret lizgehret moved this from In Analysis to Backlog in 2024.10 🎃 Jun 13, 2024
@colinvwood colinvwood added the good first issue Good for newcomers label Jul 17, 2024
gregcaporaso added a commit to caporaso-lab/using-qiime2 that referenced this issue Sep 23, 2024
gregcaporaso added a commit to caporaso-lab/using-qiime2 that referenced this issue Sep 23, 2024
gregcaporaso added a commit to caporaso-lab/using-qiime2 that referenced this issue Sep 23, 2024
gregcaporaso added a commit that referenced this issue Oct 9, 2024
fixes #577

Note that this was also addressed for the new user docs (coming soon!) in caporaso-lab/using-qiime2#3.
@lizgehret lizgehret removed this from 2024.10 🎃 Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants