Pages tagged "Services"

2018

Progenetix project Namespace

Since July 2017, the Progenetix project has a registered namespace prefix at EBI’s identifiers.org.

This prefix will gradually be used to implement a REST syntax with stable endpoints for all Progenetix resources (e.g. arraymap.org, cnvar.org …), as well as to guide to our code mapping resources.

Michael Baudis 2018-05-10: more ...

2020

Legacy API Documentation

The current implementation of the Progenetix APIs uses 2 URL endpoints:

Legacy API

  • progenetix.org/api/ has been deprecated
    • based on the original Perl libraries
    • stepwise deprecation in favour of services
    • documentation removed

2020-06-20: more ...

pgx namespace and persistant identifiers

While the pgx prefix had been registered in 2017 with identifiers.org we recently changed the resolver and target mappings on the Progenetix server. This went hand-in-hand with the generation of unique & persistant identifiers for the main data items.

2020-10-09: more ...

Services: collations

  • Documentation Link

  • Source Link

  • provides access to information about data “subsets” in the Progenetix project databases
    • typically aggregations of samples sharing an ontology code (e.g. NCIT) or external identifier (e.g. PMID)

2020-10-20: more ...

Services: Cytomapper

cytomapper Service

This script parses either:

  • a properly formatted cytoband annotation (assemblyId, cytoBands)
    • “8”, “9p11q21”, “8q”, “1p12qter”
  • a concatenated chroBases parameter
    • 7:23028447-45000000
    • X:99202660

2020-10-20: more ...

Services: dbstats

2020-10-20: more ...

Services: deliveries

  • a simple app which only provides data deliveries from handover objects
  • requires a (locally existing) accessid parameter
  • optionally limiting the response content by supplying a deliveryKeys list (can be comma-concatenated or multiple times parameter)

2020-10-20: more ...

Services: Genespans

  • Documentation Link

  • Source Link

  • genomic mappings of gene coordinats
  • initially limited to GRCh38 and overall CDS extension
  • responds to (start-anchored) text input of HUGO gene symbols using the geneId parameter
  • returns a list of matching gene objects (see below under Response Formats)
Examples

2020-10-20: more ...

Services: Geolocations

geolocations

This service provides geographic location mapping for cities above 25’000 inhabitants (~22750 cities), through either:

  • matching of the (start-anchored) name
  • providing GeoJSON compatible parameters:
    • geolongitude
    • geolatitude
    • geodistance
      • optional, in meters; a default of 10’000m (10km) is provided
      • can be used for e.g. retrieving all places (or data from places if used with publication or sample searches) in an approximate region (e.g. for Europe using 2500000 around Heidelberg…)

2020-10-20: more ...

Services: ids

The ids service forwards compatible, prefixed ids (see config/ids.yaml) to specific website endpoints. There is no check if the id exists; this is left to the web page handling itself. Stacking with the “pgx:” prefix is allowed.

2020-10-20: more ...

Services: Ontolgymaps

The ontologymaps service provides equivalency mapping between ICD-O and other classification systems, notably NCIt. The mappings are represented in the ICDOntologies project and accessible trough a front-end in the Progenetix Services area.

2020-10-20: more ...

Services: Phenopackets

The phenopackets service is usually called as a handover endpoint, to wrap & deliver penopackets from samples & variants … matched by a Beacon query.

2020-10-20: more ...

Services: Publications

The publications service serves as backend API for the display of genome screening publications through the Progenetix Publications DB.

2020-10-20: more ...

Services: Schemas
Examples

2020-10-20: more ...

Bycon Services

The bycon environment provides a number of data services which make use of resources in the Progenetix environment. Please refer to their specific documentation.

Note: As of 2021-04-07 there are some changes - typical Beacon endpoints such as biosamples have been moved to the /beacon/__service-name__ path:

services.py and URL Mapping

The service URL format progenetix.org/services/__service-name__?parameter=value is a shorthand for progenetix.org/cgi-bin/bycon/services/__service-name__.py?parameter=value.

2020-10-20: more ...

API and Services Documentation

Following the launch of the updated Progenetix website (new interface, now much more data with >130’000 samples…) and the recent introduction of the new Python based bycon API for BeaconPlus and Progenetix Services we now also have some structured information for the different API options.

2020-10-21: more ...

2021

Progenetix Source Code

With exception of some utility scripts and external dependencies (e.g. MongoDB) the following projects provide the vast majority of the software (from database interaction to website) behind Progenetix and Beacon+.

  • bycon
    • Python based service based on the GA4GH Beacon protocol
    • software powering the Progenetix resource
    • Beacon+ implementation(s) use the same code base
  • progenetix-web
    • website for Progenetix and its Beacon+ implementations
    • provides Beacon interfaces for the bycon server, as well as other Progenetix sevices (e.g. the publications repository)
    • implemented as React / Next.js project
  • PGX
    • a Perl ibrary providing utility functions for Progenetix CNV data
    • used for data transformation, e.g. binning of segmental CNV data
    • main purpose now in providing the various plots (CNV histograms, clusterd CNV profiles, array plots)

Additional Projects

  • schemas
    • Progenetix data schemas
    • represent an accessible/stable version of the schemas used in bycon
  • icdot2uberon
    • mappings between ICD-O 3 topographies and UBERON anatomical sites
  • ICDOntologies
    • mappings between ICD-O 3 morphology / topography pairs and NCIt neoplasm core cancer ontology

2021-02-06: more ...

Beacon: Biosamples

This endpoint is mostly aimed at providing biosamples handover functionality. However, the app uses the same query processing mechanism as the main byconplus application.

2021-04-16: more ...

Beacon: Variants

This endpoint is mostly aimed at providing variants Beacon functionality. The app uses the same query processing mechanism as the other bycon applications.

2021-04-16: more ...

Beacon v2: Path Examples

The Beacon v2 protocol uses a REST path structure for consistant data access.

The Beacon+ implementation - developed oin the bycon project implements an expanding set of those Beacon v2 paths for the Progenetix resource.

2021-04-23: more ...

BeaconPlus Changes

This page lists changes for the Beacon+ implementation of the “Beacon” genomics API.

2021-04-30: Closing in on Beacon v2

As one of the drivers of the Beacon protocol and to drive the Beacon v2 protocol process we have now started the documentation of Beacon v2 endpoints which are supported in Progenetix as part of the implementations-v2 project:

2021-04-30: more ...

Diagnosis Coding

The Progenetix resource utilizes standardized diagnostic coding systems, with a move towards hierarchical ontologies. As part of the coding process we have developed and provide several code mapping resources through repositories, the Progenetix website and APIs.

@mbaudis 2021-05-06: more ...

Services: IntervalFrequencies

This service provides access to binned CNV frequency information of data “collations” in the Progenetix project databases. A typical use would be the retrieval of data for a single collation, e.g. by its identifier (e.g. NCIT:C7376, PMID:22824167, pgxcohort-TCGAcancers).

2021-05-06: more ...