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

EntityClasses

R Documentation

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

Description

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

Usage

addEntityClass(
  filename,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

deleteEntityClass(
  name,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

getEntityClass(name, con = hiveConnection())

updateEntityClass(
  filename,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

listEntityClasses(con = hiveConnection())

Arguments

`filename`	A character string specifying the name of a file containing an `EntityClass` definition in JSON
`con`	A `hiveConnection` object; if not provided, a new connection will be established
`verbose`	A logical value specifying whether messages should be printed
`name`	A character string specifying the name of an `EntityClass` record to be deleted or retrieved

Value

addEntityClass, updateEntityClass: If the operation is successful, a hiveEntityClass object (invisibly).
getEntityClass: If the operation is successful, a hiveEntityClass object.
deleteEntityClass: A logical value stating whether the operation was successful.
listEntityClasses: A hiveEntityClassList object.
All functions: If an error is encountered, the function terminates with a message.