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

optional: readme/webpage on scoring method and creative-mode implementation? #616

Closed
colleenXu opened this issue Apr 12, 2023 · 2 comments
Closed
Labels
enhancement New feature or request trapi 1.4

Comments

@colleenXu
Copy link
Collaborator

colleenXu commented Apr 12, 2023

would be useful documentation.

inspired by existence of result.analyses.scoring_method (link)

Maybe this page would also include an explanation of our creative-mode method?

        scoring_method:
          type: string
          description: >-
            An identifier and link to an explanation for the method used
            to generate the score
          nullable: true

However, I'm not sure we'd want to actually add this property to every result.analyses for every result...

@colleenXu colleenXu changed the title phase 3 / optional: readme/webpage on scoring method phase 3 / optional: readme/webpage on scoring method and creative-mode implementation? Apr 12, 2023
@tokebe tokebe changed the title phase 3 / optional: readme/webpage on scoring method and creative-mode implementation? optional: readme/webpage on scoring method and creative-mode implementation? Aug 3, 2023
@tokebe tokebe added the enhancement New feature or request label Aug 3, 2023
@tokebe
Copy link
Member

tokebe commented Aug 3, 2023

Putting this one on-hold.

Tagging @andrewsu to check if this should be closed as not planned, or is worth doing at some point at a lower priority.

@andrewsu
Copy link
Member

andrewsu commented Aug 3, 2023

The wiki page for BTE is at https://github.com/NCATSTranslator/Translator-All/wiki/BioThings-Explorer-(BTE). I just updated it with some additional details of our creative mode implementation and scoring (projecting ahead a tiny bit to when our scoring overhaul is done). Anyone is welcome to continue to edit that page (but it is "good enough" for now). Since that page is listed in the infores catalog entry for BTE, a link to that page will be displayed in the Translator UI. I do not think we should add this link to result.analyses.scoring_method.

@andrewsu andrewsu closed this as completed Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request trapi 1.4
Projects
None yet
Development

No branches or pull requests

3 participants