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

MAINT: migrate types/formats/transformers to q2-types for more general access #153

Closed
gregcaporaso opened this issue Sep 19, 2023 · 2 comments · Fixed by #160
Closed

MAINT: migrate types/formats/transformers to q2-types for more general access #153

gregcaporaso opened this issue Sep 19, 2023 · 2 comments · Fixed by #160
Assignees
Labels
good first issue Good for newcomers

Comments

@gregcaporaso
Copy link
Member

gregcaporaso commented Sep 19, 2023

For example, see here.

@gregcaporaso gregcaporaso added the good first issue Good for newcomers label Sep 19, 2023
@lizgehret lizgehret changed the title migrate types/formats/transformers to q2-types for more general access MAINT: migrate types/formats/transformers to q2-types for more general access Nov 28, 2023
@lizgehret
Copy link
Member

Hey @hagenjp, I think this will be a good one for you to work on to familiarize yourself with the way that types/formats/transformers in the QIIME 2 ecosystem all work together. So, as a general jumping-off point on this one:

  1. Check out the linked example @gregcaporaso provided above for the requested types that should be moved from q2-demux to q2-types.
    a. Make sure to check out how all of the semantic types are organized within q2-types. It may make sense to add these types under the per_sample_sequences dir (cc @gregcaporaso for any thoughts on that).
  2. Take a look at the associated formats for these types under plugin_setup.py (all of the registered_semantic_type_to_format cases). All of the formats associated with the types above should also be migrated.
  3. Take a look at all of the transformers that deal with the formats that are to be migrated - those should be moved as well.
  4. Lastly, if there are any unit tests associated with the specific formats/transformers (hint: there are, and I will let you find those 🙂 ), those should be migrated as well.

When doing migrations like this, you'll want to open a PR that adds all of this functionality in the desired repo (in this case, that PR will be in q2-types), and then you'll want to open a second PR that removes this functionality from the original location (q2-demux).

Let me know if you have any questions; you can go ahead and start investigating this one when you're done with your open PRs!

@lizgehret lizgehret added this to 2024.2 Nov 28, 2023
@lizgehret lizgehret moved this to In Analysis in 2024.2 Nov 28, 2023
@hagenjp hagenjp moved this from In Analysis to In Development in 2024.2 Nov 29, 2023
@gregcaporaso
Copy link
Member Author

@lizgehret, @hagenjp, multiplexed_sequences would be a better location for these, as these are not yet per-sample.

Thanks for writing up the roadmap for this one @lizgehret!

@lizgehret lizgehret moved this from In Development to Needs Review in 2024.2 Feb 13, 2024
@lizgehret lizgehret added this to 2024.5 Feb 14, 2024
@github-project-automation github-project-automation bot moved this to Backlog in 2024.5 Feb 14, 2024
@lizgehret lizgehret moved this from Backlog to Needs Review in 2024.5 Feb 14, 2024
@lizgehret lizgehret removed this from 2024.2 Feb 14, 2024
@hagenjp hagenjp moved this from Needs Review to Changelog Needed in 2024.5 May 22, 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
good first issue Good for newcomers
Projects
No open projects
Status: Completed
Development

Successfully merging a pull request may close this issue.

3 participants