Global Beacons¶
Global Beacons lets anyone in your organization find datasets based on the entities they contain (i.e. variants, genes). Both the datasets in the public and in the private vaults can be indexed. Depending on the dataset size, indexing time may vary.
Once the dataset has been indexed, you and others will be able to perform Global Beacon Search and find this dataset.
Upsert/overwrite/delete commits are not yet supported
If the dataset you're trying to index has upsert, overwrite, or delete commits, Global Beacon search results may be inaccurate. To ensure accurate search results copy the dataset (via the UI or API) and enable Global Beacons on the new one instead.
Global Beacon Status¶
To check if the dataset has been indexed, you can select the dataset in the vault and look at the Global Beacon field in the sidebar. It can be either on or off.
Global Beacon Toggle¶
To enable/disable Global Beacon, open the dataset settings and in the the bottom of the settings window you will see information about Global Beacon for that dataset:
- Entities that dataset contains
- Global Beacon status:
on,offorindexing
While the dataset is being indexed you cannot enable/disable Global Beacon
If the indexing is in progress, you can't turn on/off Global Beacon for that dataset. Global Beacon section in the dataset settings will be disabled until indexing is completed and in the meantime you will see the indexing percentage progress.
Global Beacons with Python and R clients¶
SolveBio Python and R clients provide functionality to work with Global Beacons. With those clients you can:
- Enable/disable Global Beacon on the dataset
- Check the status of the Global Beacon on the dataset
Please upgrade your Python and R clients
Global Beacon functionality is available with the latest versions of the Python client (v2.18.0 or higher) and R client (v2.12.0 or higher).
- To upgrade Python client, run
pip install --upgrade solvebio - To upgrade R client, run
install.packages("solvebio")
Enabling Global Beacon:
1 2 3 4 5 | from solvebio import Object # Turn on Global Beacon on the dataset dataset = Object.get_by_full_path(dataset_full_path) dataset.enable_global_beacon() |
1 2 3 4 | library("solvebio") # Turn on Global Beacon on the dataset Object.enable_global_beacon(dataset_id) |
Disabling Global Beacon:
1 2 | # Disabling Global Beacon on dataset dataset.disable_global_beacon() |
1 2 | # Disabling Global Beacon on dataset Object.disable_global_beacon(dataset_id) |
Global Beacon status:
1 2 | # Getting the status of global beacon on the dataset dataset.get_global_beacon_status() |
1 2 | # Getting the status of global beacon on the dataset Object.get_global_beacon_status(dataset_id) |
For more details about the functions' response structure and for full example of Python and R clients Global Beacon functionality please see the Examples section: