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

NEW: adds ImmutableMetadata semantic type and supporting formats #293

Merged
merged 3 commits into from
Mar 27, 2023
Merged

NEW: adds ImmutableMetadata semantic type and supporting formats #293

merged 3 commits into from
Mar 27, 2023

Conversation

gregcaporaso
Copy link
Member

@gregcaporaso gregcaporaso commented Mar 8, 2023

Still to-do:

  • unit tests
  • should the formats be called MetadataFormat and MetadataDirectoryFormat (i.e., drop the Immutable from the beginning of both, since there is nothing about the formats that differs from our regular metadata files)? looking for input on this

fixes #292

A little example of how this can be used:

$ qiime tools import \
  --type ImmutableMetadata \
  --input-format ImmutableMetadataFormat \
  --input-path sample-metadata.tsv \
  --output-path sample-metadata.qza
$ qiime metadata tabulate \
  --m-input-file sample-metadata.qza \
  --o-visualization sample-metadata.qzv
$ qiime tools export \
  --input-path sample-metadata.qza \
  --output-path md/

@gregcaporaso gregcaporaso marked this pull request as ready for review March 8, 2023 23:49
@gregcaporaso gregcaporaso requested a review from lizgehret March 9, 2023 17:00
@lizgehret lizgehret self-assigned this Mar 9, 2023
Copy link
Member

@lizgehret lizgehret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally this all looks good @gregcaporaso! In terms of your question about whether this should be named ImmutableMetadata vs Metadata - I am leaning towards ImmutableMetadata just because that is a bit clearer in the intention behind adding this type and associated formats. I think that would also help folks distinguish between the Metadata class within QIIME 2 🤷‍♀️

@lizgehret lizgehret assigned gregcaporaso and unassigned lizgehret Mar 9, 2023
@gregcaporaso
Copy link
Member Author

That makes sense to me @lizgehret! I think we can merge this one when you're ready.

@lizgehret lizgehret merged commit 05d433c into qiime2:master Mar 27, 2023
@lizgehret lizgehret changed the title adds ImmutableMetadata semantic type and supporting formats NEW: adds ImmutableMetadata semantic type and supporting formats Mar 27, 2023
@gregcaporaso gregcaporaso deleted the issue-292 branch March 27, 2023 17:30
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 this pull request may close these issues.

add ImmutableMetadata semantic type
2 participants