solvebio (version 2.15.1)

Dataset.get_global_beacon_status: Dataset.get_global_beacon_status

Description

Retrieves the global beacon status for the dataset.

Usage

Dataset.get_global_beacon_status(
  id,
  raise_on_disabled = FALSE,
  env = .solveEnv
)

Arguments

id

The ID of a SolveBio dataset.

raise_on_disabled

Whether to raise an exception if Global Beacon is disabled or to return NULL.

env

(optional) Custom client environment.

References

https://docs.solvebio.com/

Examples

if (FALSE) {
Dataset.get_global_beacon_status("1234567890")
}