Entities: Add, delete, retrieve, update, or list Entity record(s)
In agower/GeneHive: R interface to a GeneHive

Entities

R Documentation

Add, delete, retrieve, update, or list Entity record(s)

Description

These functions attempt to add, delete, retrieve or update an Entity record, or to list Entity records.

Usage

addEntity(
  .class,
  ...,
  .permissions = getOption("GeneHive.permissions"),
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

deleteEntity(
  .entity_id,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

getEntity(.entity_id, con = hiveConnection())

updateEntity(
  .entity_id,
  ...,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

listEntities(.class, ..., con = hiveConnection())

Arguments

`.class`	A character string specifying the class of the `Entity` record
`...`	Additional arguments specifying fields of the `Entity` record to be added or updated, or fields on which to limit a listing
`.permissions`	A `hivePermissions` object specifying the permissions to be used when creating the record
`con`	A `hiveConnection` object; if not provided, a new connection will be established
`verbose`	A logical value specifying whether messages should be printed
`.entity_id`	A character string or `UUID` specifying the unique identifier of an `Entity` record to be deleted or retrieved

Details

In functions deleteEntity, getEntity, and updateEntity, the .class argument does not need to be specified, but if present, these functions will check that it matches the class of the Entity record corresponding to the identifier in argument .entity_id.

Value

addEntity, updateEntity: If the operation is successful, a hiveEntity object (invisibly).
getEntity: If the operation is successful, a hiveEntity object.
deleteEntity: A logical value stating whether the operation was successful.
listEntities: A hiveEntityList object.
All functions: If an error is encountered, the function terminates with a message.