hiveUtilities: Utility functions used by other functions

In agower/GeneHive: R interface to a GeneHive

Utility functions used by other functions

Description

These convenience functions perform low-level tasks used by other GeneHive functions.

Usage

hiveApp(
  type = c("Entity", "EntityClass", "Group", "User", "WorkFileProperties")
)

hiveExists(
  id,
  type = c("Entity", "EntityClass", "Group", "User", "WorkFileProperties"),
  con = hiveConnection()
)

hiveKeyFields(class, con = hiveConnection())

hiveLabelFields(class, con = hiveConnection())

hiveS4Class(
  type = c("Entity", "EntityClass", "Group", "User", "WorkFileProperties"),
  class
)

hiveSlotName(
  Class,
  attribute = c("creationDate", "creator", "description", "group", "id", "name",
    "owner", "permissions", "updated")
)

Arguments

type	A character string representing a record type; defaults to "Entity"
id	A character string specifying a record identifier
con	A hiveConnection object
class	A character string representing an Entity class; in function hiveS4Class, this is an optional argument that is used to determine S4 class if type = "Entity"
Class	A character string representing an S4 object class
attribute	A character string representing an attribute (e.g., "id", "name") for which the corresponding slot name is desired

Value

hiveApp

A character vector of length 1 specifying the app name to be used in the API URL

hiveExists

A logical value specifying whether a record of the given type exists with the given identifier

hiveKeyFields

A character vector containing the names of any 'key' fields of an Entity class (i.e., those used to compute the UUID of the record), or, if no key fields exist for the class, a character vector of length 0

hiveS4Class

If the input corresponds to a valid S4 object class, it is returned; otherwise, NULL.

hiveSlotName

A character vector of length 1 containing the name of the slot that corresponds to the specified attribute

Author(s)

Adam C. Gower [e-mail]

agower/GeneHive documentation built on April 14, 2022, 5:08 a.m.