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

Better documentation about name, label and api-field #40

Open
huaiyumi opened this issue Jun 11, 2024 · 0 comments
Open

Better documentation about name, label and api-field #40

huaiyumi opened this issue Jun 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@huaiyumi
Copy link
Collaborator

These three fields can be different. Label is the term shown on the AnnoQ website. Name is the actual term used in the database. Api-field is the term used for api query.
Here is an example:

label: PEREGRINE_enhancer_linked_genes
name: enhancer_linked_genes
api_field: enhancer_linked_genes

Here the label is different from the name in the backend.

Here is another example:

name: 1000Gp3_AC
api_field: _1000Gp3_AC

Here the label and the name are the same, but api_field has an extra '_' added at the beginning, because api field can't start witha number.

The details of these mappings can be found at http://annoq.org/api-v2/annotations.

We need to provide more support to help users to handle these. Specifically,

  1. We need to better documentation/instructions for developers who write api queries from command line or develop packages.
  2. For end users who use packages, they just need to use the 'label' to query. Therefore, the packages should take care of it.

Please comment.

@huaiyumi huaiyumi added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant