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

RE2022-300: add display name and category for genome attrib #611

Merged
merged 2 commits into from
Jan 11, 2024

Conversation

Tianhao-Gu
Copy link
Collaborator

@Tianhao-Gu Tianhao-Gu commented Jan 11, 2024

example genome_attribs_meta:

{"columns": [{"key": "fastani_af", "type": "float", "filter_strategy": null, "display_name": "FastANI AF", "category": "Other", "description": null, "min_value": 0.76, "max_value": 0.76, "enum_values": null}, {"key": "Completeness", "type": "float", "filter_strategy": null, "display_name": "CheckM Completeness", "category": "Quality", "description": null, "min_value": 76.76, "max_value": 98.07, "enum_values": null}, {"key": "fastani_reference", "type": "string", "filter_strategy": "identity", "display_name": "FastANI Reference", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "closest_placement_reference", "type": "string", "filter_strategy": "identity", "display_name": "Closest Placement Reference", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "user_genome", "type": "string", "filter_strategy": "identity", "display_name": "User Genome", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "_mtchsel", "type": "string", "filter_strategy": "identity", "display_name": null, "category": null, "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "classification_method", "type": "string", "filter_strategy": "fulltext", "display_name": "Classification Method", "category": "Taxonomy", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "fastani_taxonomy", "type": "string", "filter_strategy": "fulltext", "display_name": "FastANI Taxonomy", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "kbase_display_name", "type": "string", "filter_strategy": "ngram", "display_name": "KBase Name", "category": "Identifiers", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "closest_placement_ani", "type": "float", "filter_strategy": null, "display_name": "Closest Placement ANI", "category": "Other", "description": null, "min_value": 76.9, "max_value": 96.85, "enum_values": null}, {"key": "fastani_ani", "type": "float", "filter_strategy": null, "display_name": "FastANI ANI", "category": "Other", "description": null, "min_value": 96.85, "max_value": 96.85, "enum_values": null}, {"key": "closest_placement_radius", "type": "float", "filter_strategy": null, "display_name": "Closest Placement Radius", "category": "Other", "description": null, "min_value": 95.0, "max_value": 95.0, "enum_values": null}, {"key": "load_ver", "type": "string", "filter_strategy": "identity", "display_name": null, "category": null, "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "classification", "type": "string", "filter_strategy": "ngram", "display_name": "Classification", "category": "Taxonomy", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "red_value", "type": "string", "filter_strategy": "fulltext", "display_name": "Red Value", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "kbase_id", "type": "string", "filter_strategy": "identity", "display_name": "KBase ID", "category": "Identifiers", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "Contamination", "type": "float", "filter_strategy": null, "display_name": "CheckM Contamination", "category": "Quality", "description": null, "min_value": 0.05, "max_value": 2.3, "enum_values": null}, {"key": "pplacer_taxonomy", "type": "string", "filter_strategy": "fulltext", "display_name": "pplacer Taxonomy", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "note", "type": "string", "filter_strategy": "fulltext", "display_name": "Note", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "coll", "type": "string", "filter_strategy": "identity", "display_name": null, "category": null, "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "closest_placement_af", "type": "float", "filter_strategy": null, "display_name": "Closest Placement AF", "category": "Other", "description": null, "min_value": 0.093, "max_value": 0.84, "enum_values": null}, {"key": "warnings", "type": "string", "filter_strategy": "fulltext", "display_name": "Warnings", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "kbase_sample_id", "type": "string", "filter_strategy": "identity", "display_name": "KBase Sample ID", "category": "Identifiers", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "other_related_references(genome_id,species_name,radius,ANI,AF)", "type": "string", "filter_strategy": "fulltext", "display_name": "Other Related References", "category": "Other", "description": null, "min_value": null, "max_value": null, "enum_values": null}, {"key": "fastani_reference_radius", "type": "float", "filter_strategy": null, "display_name": "FastANI Reference Radius", "category": "Other", "description": null, "min_value": 95.0, "max_value": 95.0, "enum_values": null}, {"key": "msa_percent", "type": "float", "filter_strategy": null, "display_name": "MSA Percent", "category": "Other", "description": null, "min_value": 68.52, "max_value": 95.23, "enum_values": null}, {"key": "translation_table", "type": "int", "filter_strategy": null, "display_name": "Translation Table", "category": "Other", "description": null, "min_value": 11, "max_value": 11, "enum_values": null}], "count": 5, "_key": "8b838895201f80d818a1e3325cede938", "coll": "GROW", "load_ver": "tian_test_taskfarmer"}

Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (77d63eb) 46.53% compared to head (83bb78c) 47.13%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #611      +/-   ##
==========================================
+ Coverage   46.53%   47.13%   +0.59%     
==========================================
  Files          75       75              
  Lines        6627     6460     -167     
==========================================
- Hits         3084     3045      -39     
+ Misses       3543     3415     -128     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MrCreosote
Copy link
Member

MrCreosote commented Jan 11, 2024

You'll need to add them to the models as well so they're documented in the openapi docs (and may even be necessary for them to return in the api, not sure about that)

@MrCreosote
Copy link
Member

No description placeholder?

@Tianhao-Gu
Copy link
Collaborator Author

You'll need to add them to the models as well so they're documented in the openapi docs (and may even be necessary for them to return in the api, not sure about that

are you referring to the AttributesColumnSpec model? It will be included in the next PRs. Didn't include the changes here to avoid potential confusion for Cody.
https://github.com/kbase/collections/blob/main/src/common/product_models/columnar_attribs_common_models.py#L52

@Tianhao-Gu
Copy link
Collaborator Author

No description placeholder?

No description in the google doc yet (not in road map neither). I don't think we need a placeholder in the yaml file yet.

@MrCreosote
Copy link
Member

MrCreosote commented Jan 11, 2024

are you referring to the AttributesColumnSpec model? It will be included in the next PRs

Fair enough

@MrCreosote
Copy link
Member

No description in the google doc yet (not in road map neither). I don't think we need a placeholder in the yaml file yet.

It is in the roadmap, although there's a question mark by it. But based on the discussion in the standup we'll go ahead with the placeholder in the yaml docs

@Tianhao-Gu
Copy link
Collaborator Author

No description placeholder?

No description in the google doc yet (not in road map neither). I don't think we need a placeholder in the yaml file yet.

added place holder for description as discussed in standup.

Copy link
Member

@MrCreosote MrCreosote left a comment

Choose a reason for hiding this comment

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

LGTM. I'm relying on Cody to confirm that the actual content is correct

Copy link
Member

@MrCreosote MrCreosote left a comment

Choose a reason for hiding this comment

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

&&^)&*(^)

@MrCreosote
Copy link
Member

I'm relying on Cody to confirm that the actual content is correct

Which he did in Slack

@Tianhao-Gu Tianhao-Gu merged commit 0275e7e into main Jan 11, 2024
11 checks passed
@Tianhao-Gu Tianhao-Gu deleted the dev_genome_attrib_display_name branch January 11, 2024 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants