Object.get_global_beacon_status: Object.get_global_beacon_status

View source: R/object.R

Object.get_global_beacon_statusR Documentation

Object.get_global_beacon_status

Description

Retrieves the global beacon status for the specified dataset.

Usage

Object.get_global_beacon_status(
  id,
  raise_on_disabled = FALSE,
  env = solvebio:::.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

## Not run: 
Object.get_global_beacon_status("1234567890")
Object.get_global_beacon_status("1234567890", raise_on_disabled=TRUE)

## End(Not run)


solvebio documentation built on May 17, 2022, 5:06 p.m.