Skip to content

New "query-over-time" endpoint #1480

@fhennig

Description

@fhennig

As an API user I want to be able to provide a list of advanced queries, checking multiple different combinations of mutations, and getting back the data of how prevalent these mutation combinations are.

This feature builds on the usefulness of mutations-over-time, making it possible to search for c-oocurrences of mutations instead of individual mutations. It also allows to search for variant signatures over time.

Endpoint details

A new endpoint will be added: /component/queriesOverTime, with similar options as the mutationsOverTime endpoints.

Similar:

  • filters object to set the base filter of sequences to consider
  • dateRanges and dateField to supply the list of date ranges to consider

Different/new:

  • queries: a list of objecs with keys:
    • countQuery: A query like A23T | A24T
    • coverageQuery: A query like !23N & !24N

The coverageQuery will for now be required to be provided explicitly, because it's not trivial to decide what "coverage" means of any given query. In the future we can possibly make this optional, and develop a default for coverage calculation.


Edit: We also need the equivalent to this: #1349

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions