BeaconPlus - Beacon Front-end for Genomic Data Queries

As part of the Beacon project, since early 2016 the Theoretical Cytogenetics and Oncogenomics Group at the University of Zurich develops the Beacon⁺ demonstrator, to show current functionality and test future Beacon protocol extensions.

The Beacon⁺ implementation is a custom front end on top of the bycon code with emphasis on structural genome variations from cancer samples.

An extended implementation of the Beacon⁺ code is provided through the Progenetix project.s

More Documentation

The documentation relevant to the API can be found in these locations:

• bycon package documentation
• Beacon v2 documentation site

Installation

The project code for the BeaconPlus front end lives inside bycon/beaconplusWeb and is tested as a static compiled React project (YMMV ...).

Configuration

Please edit the target installation directory server_site_dir_loc in the local/local_paths.yaml configuration file.

Adjustments to dataset definitions etc. being used by the front end are in bycon/beaconplusWeb/src/config.js.

Additionally runtime variables for server name etc. should be set in the environmental definitions in bycon/beaconplusWeb/env.

Compile & Install

The developer runner updev.sh also calls the install.py script which asks for installation of the front end. It boils down to

cd bycon/beaconplusWeb
npm run local

... for local test installations or

cd bycon/beaconplusWeb
npm run update

... for the outside facing server one (YMMV; these just invoke different settings defined in bycon/beaconplusWeb/env).