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

Allow disabling 3' Shifting in the rest server #555

Merged
merged 1 commit into from
Sep 12, 2022

Conversation

janeliutw
Copy link
Contributor

@janeliutw janeliutw commented Aug 19, 2022

@holtgrewe,

I work on @CarlosBorroto 's team, and this PR is continuing the discussion on #551 . I saw that there's a fix(#553) to enable --no-3-prime-shifting argument for annotate-pos command, thanks for fixing it! In our use cases, we use the rest server to annotate variants., so we are hoping to have an option to disable 3' shifting on the rest server as well.

We noticed that when running rest-server command, --no-3-prime-shifting is already an optional argument.

MDMBJALIU:target jliu$ java -jar jannovar-cli-0.40-SNAPSHOT.jar rest-server --help
usage: jannovar-cli rest-server [-h] [--host HOST] [--port PORT] -d DATABASE [--show-all] [--no-3-prime-shifting] [--3-letter-amino-acids] [--version] [--report-no-progress] [-v] [-vv] [--http-proxy HTTP_PROXY]
                    [--https-proxy HTTPS_PROXY] [--ftp-proxy FTP_PROXY]

it's just not actually being hooked up yet. So in this PR, we proposed a change to enable --no-3-prime-shifting in the rest server:

  • Enable --no-3-prime-shifting argument in the Rest Server.
    To disable shifting variants towards the 3' end of the transcript, run the rest server with --no-3-prime-shifting argument.
    For example,
    java -jar jannovar-cli-0.40-SNAPSHOT.jar rest-server -d data/hg19_refseq.ser --no-3-prime-shifting

Additionally, we proposed a new query param that allow a user to disable 3 prime shifting in an api request.

  • Accept no-3-prime-shifting as an api query param to temporarily disable 3 prime shifting.
    For example,
    https://{base_url}/annotate-var/refseq/hg19/chrX/108924495/C/CTTA?no-3-prime-shifting
    Notice that this query param is only for disabling 3' shifting, so if will only take effect if the rest server is running with 3' shift enabled.

Please let me know your thoughts on the changes or if I miss anything. Thank you!

…3-prime-shifting` as an api query param to temporarily disable 3 prime shifting.
Copy link
Contributor

@visze visze left a comment

Choose a reason for hiding this comment

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

LGTM. thank you! @holtgrewe any comments?

@CarlosBorroto
Copy link

CarlosBorroto commented Aug 29, 2022

Hi @holtgrewe @visze, we are wondering what timeline would be reasonable to expect for this PR to get merged and included in a release? We understand there are no hard promises we should expect, just trying to decide if we should go with an internally built jar for a bit, while this gets fully baked into upstream.

@holtgrewe
Copy link
Member

Again - thanks a bunch! I will merge this together with your other PR and then make a release.

@holtgrewe holtgrewe merged commit a6d715a into charite:main Sep 12, 2022
@janeliutw janeliutw deleted the disable-3-prime-shifting branch September 29, 2022 14:06
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.

4 participants