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

3388 allow organisms without consensus sequences #3537

Merged
merged 15 commits into from
Jan 22, 2025

Conversation

fengelniederhammer
Copy link
Contributor

@fengelniederhammer fengelniederhammer commented Jan 17, 2025

resolves #3388

preview URL: https://3388-allow-organisms-with.loculus.org/

Summary

This allows having no (consensus) sequence data in sequence entries. Changes include:

  • The respective organism needs to be configured with allowSubmissionOfConsensusSequences: false in the values.yml.
  • The reference genomes can be empty ({ "nucleotideSequences": [], "genes": [] })
  • The backend allows uploads without a sequence file for such organisms
    • The sequences will always be an empty object/map.
    • It doesn't validate that the preprocessing pipeline doesn't submit sequences.
  • The website doesn't require a sequence file in uploads (and has slightly adaptes texts there)
    grafik
  • The edit page doesn't show sequence data
    grafik
  • The mutation filter is not shown
    grafik
  • The sequence details page doesn't show sequence data:
    grafik
  • The download dialog doesn't offer sequence downloads:
    grafik

Screenshot

PR Checklist

  • All necessary documentation has been adapted.
  • The implemented feature is covered by an appropriate test.

@fengelniederhammer fengelniederhammer added the preview Triggers a deployment to argocd label Jan 17, 2025
@fengelniederhammer fengelniederhammer force-pushed the 3388-allow-organisms-without-sequences branch from 6dd1ca6 to 1fd2905 Compare January 17, 2025 12:35
@fengelniederhammer fengelniederhammer changed the title 3388 allow organisms without sequences 3388 allow organisms without consensus sequences Jan 17, 2025
@fengelniederhammer fengelniederhammer linked an issue Jan 17, 2025 that may be closed by this pull request
@fengelniederhammer fengelniederhammer force-pushed the 3388-allow-organisms-without-sequences branch from f7c0964 to c2ea82b Compare January 17, 2025 15:28
@fengelniederhammer fengelniederhammer marked this pull request as ready for review January 17, 2025 15:43
@fengelniederhammer
Copy link
Contributor Author

I just noticed that the backend still requires the submissionId in the metadata uploads. Actually they are not relevant, because the metadata entries don't need to be matched on sequences. But maybe it's still good to keep them (to have less complex changes and to have them still around when we e.g. allow uploading of raw sequences later)?

@chaoran-chen
Copy link
Member

I agree, let's leave the submissionId mandatory. When we start uploading raw sequences, the ID will also be needed.

@chaoran-chen chaoran-chen requested a review from fhennig January 20, 2025 10:25
@fhennig
Copy link
Contributor

fhennig commented Jan 21, 2025

You mentioned in the summary that the backend doesn't check that the pipeline doesn't upload sequences; does that mean that uploading sequences via API is still possible? What happens if sequences are still uploaded? Will the data just be in SILO but just generally ignored?

@fengelniederhammer
Copy link
Contributor Author

You mentioned in the summary that the backend doesn't check that the pipeline doesn't upload sequences; does that mean that uploading sequences via API is still possible? What happens if sequences are still uploaded? Will the data just be in SILO but just generally ignored?

I would need to check. Maybe it's not even true what I wrote and the backend actually checks that there are no superfluous sequences. At the latest, SILO would complain.

Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

I still have to go through the kt files, but I wanted to submit a first batch of comments already.

kubernetes/loculus/templates/_common-metadata.tpl Outdated Show resolved Hide resolved
website/src/types/config.ts Outdated Show resolved Hide resolved
website/src/types/referencesGenomes.ts Show resolved Hide resolved
website/src/components/Submission/DataUploadForm.tsx Outdated Show resolved Hide resolved
website/src/components/Submission/DataUploadForm.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes! It looks good to me now. Also the Kotlin code looks good!

@fhennig
Copy link
Contributor

fhennig commented Jan 22, 2025

still looks good to me 👍

@fengelniederhammer fengelniederhammer merged commit 3229be7 into main Jan 22, 2025
24 checks passed
@fengelniederhammer fengelniederhammer deleted the 3388-allow-organisms-without-sequences branch January 22, 2025 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Triggers a deployment to argocd
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow organisms without sequences
4 participants