Beacon.create: Beacon.create

Description Usage Arguments References Examples

View source: R/beacon.R

Description

Add a new beacon to an existing beacon set. The beacon set must already exist in order to add beacons.

Usage

1
2
Beacon.create(beacon_set_id, vault_object_id, title,
  env = solvebio:::.solveEnv, ...)

Arguments

beacon_set_id

The ID of the parent beacon set.

vault_object_id

The ID of the vault object (i.e. dataset) queried by the beacon.

title

The title displayed for the beacon.

env

(optional) Custom client environment.

...

(optional) Additional beacon attributes (such as description and params).

References

https://docs.solvebio.com/

Examples

1
2
3
4
5
6
7
8
## Not run: 
Beacon.create(
              beacon_set_id="1234",
              vault_object_id="1234567890",
              title="My new beacon"
              )

## End(Not run)

solvebio documentation built on July 12, 2018, 9:04 a.m.